documentation
Help write clear documentation (docstrings, README, API docs). Use PROACTIVELY when documentation is needed. Keywords: docs, documentation, ドキュメント, README
When & Why to Use This Skill
This Claude skill automates the creation of high-quality technical documentation, including Google-style docstrings, comprehensive README files, and detailed API documentation. By proactively identifying undocumented code and utilizing standardized templates, it ensures your codebase remains maintainable, professional, and easy to navigate for developers and stakeholders alike.
Use Cases
- Automated Docstring Generation: Proactively generating Google-style docstrings for new public functions and classes to improve code readability and maintainability.
- Project Onboarding: Creating and structuring comprehensive README files that provide clear instructions for project setup, usage, and contribution.
- API Reference Documentation: Drafting detailed documentation for API endpoints to ensure seamless integration and clear communication of interface requirements.
- Standardizing Documentation Style: Applying consistent type hints and documentation patterns across a repository to meet professional technical writing standards.
| name | documentation |
|---|---|
| description | Help write clear documentation (docstrings, README, API docs). Use PROACTIVELY when documentation is needed. Keywords: docs, documentation, ドキュメント, README |
When to Use (PROACTIVE)
- New public function/class without docstring
- User requests documentation
- User mentions "docs", "ドキュメント", "README"
- API endpoint needs documentation
What This Skill Does
Provides documentation patterns:
- Google-style docstrings
- README structure
- API documentation
- Type hints
Refer to docs-guide.md for templates.