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. allowed-tools:
- Read
- Write
- Edit
- Glob model: sonnet
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
- 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)
chat Comments (0)
Sign in to join the discussion and leave a comment.
Skill Details
GitHub Stars
2
GitHub Forks
0
Created
Jan 2026
Last Updated
il y a 5 mois
tools
tools automation tools
Related Skills
Build your own?
Join 12,000+ developers contributing to the Claude ecosystem.
No comments yet. Be the first to share your thoughts!