documentation

帮助编写清晰的文档(文档字符串、README、API文档)。在需要文档时主动使用。关键词:docs、documentation、ドキュメント、README

📖 中文导读:帮助编写清晰的文档(文档字符串、README、API文档)。在需要文档时主动使用。关键词:docs、documentation、ドキュメント、README 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

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.