documentation
Defines rules for maintaining documentation, READMEs, and code comments to prevent knowledge drift.
Install
mkdir -p .claude/skills/documentation-popo0407 && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/15154" && unzip -o skill.zip -d .claude/skills/documentation-popo0407 && rm skill.zipInstalls to .claude/skills/documentation-popo0407
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
ドキュメント作成とナレッジ管理の原則Key capabilities
- →Synchronize documentation with code and configuration changes
- →Describe the 'why' in code comments using English
- →Update README.md for new features or specification changes
- →Ensure API specifications are current with endpoints, request/response formats, and error codes
- →Add new environment variables to .env.example
- →Update architecture diagrams when system configuration changes
How it works
This skill outlines a checklist for updating various documentation types to ensure they remain synchronized with code and configuration changes.
Inputs & outputs
When to use documentation
- →Update README specifications
- →Sync API documentation
- →Organize project knowledge
About this skill
ドキュメントとナレッジ管理の原則
- 同期更新: コードや設定に変更を加える際は、ドキュメントを同時に更新する。README、API 仕様、
.env.exampleなどを最新状態に保ち、コードとの乖離を防ぐ。 - コードコメント: コメントには「なぜそうしたか」を英語で記述し、「何をしているか」はコードが説明できる状態を維持する。
ドキュメント更新チェックリスト
- README.md: 新機能や仕様変更が反映されているか
- API 仕様書: エンドポイント、リクエスト/レスポンス形式、エラーコードが最新か
- 環境変数:
.env.exampleに新しい環境変数が追加されているか - アーキテクチャ図: システム構成に変更があった場合、図も更新されているか
- トラブルシューティング: 新しいエラーや対処法があれば追記されているか
SKILL.md 記載ルール
各スキルファイル（.github/skills/*/SKILL.md）は、以下のガイドラインに従って作成・更新します。
記載内容の原則
-
汎用的な技術知識・ベストプラクティスのみ記載
- 他のプロジェクトでも役立つ普遍的な知見
- 言語やフレームワークの一般的なパターン
- 業界標準のアプローチ
-
本システム固有の要素は記載しない
- ファイル名や関数名など具体的なコード実装
- このプロジェクト特有のディレクトリ構成
- 業務ルールや組織的な制約
-
具体的なコード例は必要に応じて
- 間違いやすい内容の場合のみ具体例を示す
- 汎用的でクリアなコード例に限定
- 複雑すぎる実装例は避ける
スキルの粒度
- 3-5ページ程度（セクション数: 5-10）を目安
- 1つのスキルは1つの責務に特化
- 複デューシャドムの場合は別スキルに分割
When not to use it
- →When documenting system-specific elements like file names or specific code implementations
- →When describing project-specific directory structures
- →When detailing business rules or organizational constraints
Limitations
- →The skill only covers general technical knowledge and best practices, not project-specific details
- →The skill limits concrete code examples to only when the content is prone to error
- →The skill suggests a maximum length of 3-5 pages or 5-10 sections per skill file
How it compares
This approach enforces a synchronous update process for documentation, preventing discrepancies between code and its corresponding descriptions, unlike ad-hoc documentation practices.
Compared to similar skills
documentation side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| documentation (this skill) | 0 | 4mo | Review | Beginner |
| dify-docs-guides | 0 | 1mo | Review | Advanced |
| prd | 0 | 4mo | No flags | Intermediate |
| postmortem-writing | 17 | 2mo | No flags | Beginner |
Try saying
Example prompts that trigger this skill in your AI assistant.
You might also like
dify-docs-guides
langgenius
>
prd
alfredolopez80
Product Requirements Document generation and management with INVEST-compliant user stories
postmortem-writing
wshobson
Write effective blameless postmortems with root cause analysis, timelines, and action items. Use when conducting incident reviews, writing postmortem documents, or improving incident response processes.
internal-comms
anthropics
A set of resources to help me write all kinds of internal communications, using the formats that my company likes to use. Claude should use this skill whenever asked to write some sort of internal communications (status reports, leadership updates, 3P updates, company newsletters, FAQs, incident reports, project updates, etc.).
wiki-page-writer
microsoft
Generates rich technical documentation pages with dark-mode Mermaid diagrams, source code citations, and first-principles depth. Use when writing documentation, generating wiki pages, creating technical deep-dives, or documenting specific components or systems.
confluence-assistant
tech-leads-club
Expert in Confluence operations using Atlassian MCP - automatically detects workspace Confluence configuration or prompts for site details. Use for searching, creating, updating pages, managing spaces, and adding comments with proper Markdown formatting.