Documentation Patterns Skill
Overview
This skill teaches how to create clear, comprehensive documentation for Python projects including README, API docs, and guides.
Principles
- •Be Clear and Concise: Avoid jargon when possible
- •Provide Examples: Show, don't just tell
- •Keep It Updated: Update docs with code changes
- •Use Consistent Style: Follow style guide throughout
- •Include Screenshots: For UI-related projects
Key Capabilities
1. Documentation Types
- •README files
- •API documentation
- •User guides
- •Developer guides
- •Architecture documentation
- •Changelogs
2. Documentation Tools
- •Sphinx (with autodoc)
- •MkDocs
- •Markdown
- •reStructuredText
- •Google/NumPy docstring styles
3. Best Practices
- •Clear project description
- •Installation instructions
- •Quick start guide
- •Usage examples
- •API reference
When to Use This Skill
Load this skill when:
- •Writing or updating README
- •Creating API documentation
- •Writing docstrings
- •Creating user guides
- •Documenting architecture
Sections
- •
readme-structure.md: README template and best practices - •
docstring-styles.md: Google and NumPy docstring styles - •
api-documentation.md: API reference format - •
documentation-tools.md: Sphinx, MkDocs, Markdown