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