スキルKnowledge Work
📚documentation
- プラグイン
- Engineering
- ソース
- GitHub で見る ↗
説明
技術ドキュメントを作成・管理する。 次のような場合に使用: - 「write docs for」「document this」「create a README」「write a runbook」「onboarding guide」などのキーワードが含まれている場合 - API ドキュメント、アーキテクチャドキュメント、運用用 runbook など、あらゆる形式の技術ドキュメント作成でユーザーがサポートを必要としている場合
原文を表示
Write and maintain technical documentation. Trigger with "write docs for", "document this", "create a README", "write a runbook", "onboarding guide", or when the user needs help with any form of technical writing — API docs, architecture docs, or operational runbooks.
ユースケース
- ✓技術ドキュメントを作成する
- ✓APIドキュメントを書く
- ✓アーキテクチャドキュメントを作成する
- ✓運用用runbookを書く
- ✓オンボーディングガイドを作成する
本文
Technical Documentation
Write clear, maintainable technical documentation for different audiences and purposes.
Document Types
README
- What this is and why it exists
- Quick start (< 5 minutes to first success)
- Configuration and usage
- Contributing guide
API Documentation
- Endpoint reference with request/response examples
- Authentication and error codes
- Rate limits and pagination
- SDK examples
Runbook
- When to use this runbook
- Prerequisites and access needed
- Step-by-step procedure
- Rollback steps
- Escalation path
Architecture Doc
- Context and goals
- High-level design with diagrams
- Key decisions and trade-offs
- Data flow and integration points
Onboarding Guide
- Environment setup
- Key systems and how they connect
- Common tasks with walkthroughs
- Who to ask for what
Principles
- Write for the reader — Who is reading this and what do they need?
- Start with the most useful information — Don't bury the lede
- Show, don't tell — Code examples, commands, screenshots
- Keep it current — Outdated docs are worse than no docs
- Link, don't duplicate — Reference other docs instead of copying
原文・著作権は Anthropic および各プラグイン作者に帰属します。日本語訳は Claude API による自動翻訳です。