| name | documentation |
| description | Provides documentation standards for README, API docs, code comments, changelogs, and project cleanup. Use when writing documentation, README files, API references, or cleaning up project files. |
Documentation Skill
When to Use
- Writing README files
- Creating API documentation
- Writing code comments and docstrings
- Maintaining changelogs
- Cleaning up and organizing project files
- Setting up linting and formatting tools
Quick Reference
Documentation Standards
Language Conventions
Project Cleanup
Core Principles
- English for code and docs: All source code and documentation in English
- Meaningful comments: Explain why, not what
- Semantic versioning: MAJOR.MINOR.PATCH for version numbers
- Clean project structure: Maintain .gitignore and remove temporary files
- Consistent formatting: Use language-appropriate formatters (Prettier, Black, clang-format)