Enforce best practices for writing human-readable documentation.
npx skills add https://github.com/jon23d/skillz --skill human-readable-docs
Please help me install this Agent Skill. Skill: human-readable-docs Source: https://github.com/jon23d/skillz/tree/main/skills/human-readable-docs Command: npx skills add https://github.com/jon23d/skillz --skill human-readable-docs
This Skill helps agents write documentation that is clear, concise, and easy for humans to understand, avoiding common pitfalls that make technical writing inaccessible.
Use the human-readable-docs skill to rewrite the provided technical description into a user-friendly guide.
High-intent search queries and answers about installing and using this skill.
To write scannable technical documentation, use active voice, second-person perspective, and logical content ordering. Structure README files and API references with clear headings, concise paragraphs, and practical code examples that guide the reader through their task.
The best way to format tables and code examples in API references is to ensure tables are well-structured and code is runnable. Clear parameter descriptions and practical code snippets help developers understand and use the API effectively without unnecessary prose.
Rewrite a technical description into a user-friendly guide by applying readability best practices. Focus on reducing prose density, adopting an active voice, and structuring the content logically based on reader needs to make the information accessible.
Markdown documentation often feels inaccessible due to high prose density, passive voice, and poor structure. Enforcing active voice, second-person perspective, and appropriate paragraph length makes technical writing clear and concise for human readers.
Yes, you can improve readability for long-form guides by ordering information based on reader needs, optimizing table formatting, and ensuring code examples remain practical. This approach keeps documentation scannable and focused on the user's task.
You should avoid passive voice in README files when writing instructions or API references. Active voice and second-person perspective reduce ambiguity, making documentation more direct, scannable, and easier for developers to follow.
AICode-NexusFormat Markdown documents by adjusting headings, bold, lists, and code blocks.
zzafergokConvert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.
ARAVINDAN20Apply project style guides and character voice conventions to prose drafting and editing.
AhmadGehadCompress AI-generated text into caveman-style prose with adjustable intensity levels.
