Technical Documentation Writing

This skill activates when writing or improving technical documentation, including README files, API documentation, user guides, and inline code documentation.

When to Use This Skill

Activate when:

• Writing README files
• Creating API documentation
• Writing user guides or tutorials
• Documenting code with comments or docstrings
• Creating architecture or design documents
• Writing changelogs or release notes

README Files

Essential README Structure

Every README should include: