documentation - Technical Documentation Best Practices
Technical documentation best practices for READMEs, API docs, comments, diagrams, and guides
Tags
Updated: 2026-05-28Capabilities
Typical Inputs
Typical Outputs
What this skill does
- write README
- write API docs
- add code comments
- create diagrams
- write tutorials
- write guides
- create changelog
- document endpoints
- write docstrings
Inputs
- project information
- API specifications
- code files
- architecture details
- code examples
- version history
- authentication details
Outputs
- README files
- API reference documents
- inline comments
- architecture diagrams
- user guides
- tutorials
- changelog documents
Requirements
- Markdown knowledge
- technical writing skills