documentation

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

Reference Documents (Import Syntax)

Documentation Standards

@./reference/documentation.md

Language Conventions

@./reference/communication.md

Project Cleanup

@./reference/cleanup.md

Core Principles

1. English for code and docs: All source code and documentation in English
2. Meaningful comments: Explain why, not what
3. Semantic versioning: MAJOR.MINOR.PATCH for version numbers
4. Clean project structure: Maintain .gitignore and remove temporary files
5. Consistent formatting: Use language-appropriate formatters (Prettier, Black, clang-format)