home/categories/code-quality/wahidyankf-open-sharia-enterprise-claude-skills-readme-writing-readme-files-skill-md
code-qualitytesting-security

readme-writing-readme-files

README quality standards for engaging, accessible, scannable content including problem-solution hooks, plain language (no unexplained jargon), acronym context, paragraph limits (≤5 lines), benefits-focused language, visual hierarchy, and progressive disclosure. Essential for creating effective README files that welcome and guide users.

wahidyankf
maintainer
wahidyankf
آخر تحديث 1/20/2026
النجوم
4
التفرعات
1
quick start

Installation and usage

README quality standards for engaging, accessible, scannable content including problem-solution hooks, plain language (no unexplained jargon), acronym context, paragraph limits (≤5 lines), benefits-focused language, visual hierarchy, and progressive disclosure. Essential for creating effective README files that welcome and guide users.

التثبيت
$ install --globalskills.sh
الاستخدام

بعد التثبيت، يمكنك استخدام هذه المهارة بتشغيل الأمر التالي في الطرفية:

skills use readme-writing-readme-files