document-writer

ドキュメントライター

目的

ソフトウェアシステム向けの構造化された技術ドキュメントの作成に関する専門知識を提供します。アーキテクチャ決定記録、RFC、設計ドキュメント、ナレッジベースの記事を専門としています。

使用する場面

• アーキテクチャ決定記録（ADR）の作成
• RFC（コメント募集）ドキュメントの作成
• システム設計のドキュメント化
• 技術仕様書の作成
• ランブックやプレイブックの作成
• 社内ナレッジベースの構築
• インシデント（事後検証）のドキュメント化

クイックスタート

次の場合にこのスキルを呼び出してください：

• アーキテクチャ決定記録（ADR）の作成
• RFC ドキュメントの作成
• システム設計のドキュメント化
• 技術仕様書の作成
• ランブックやプレイブックの作成

次の場合は呼び出さないでください：

• API ドキュメントの作成（api-documenter を使用）
• ユーザー向けドキュメントの作成（technical-writer を使用）
• Word ドキュメントの作成（docx-skill を使用）
• マーケティングコンテンツの作成（content-marketer を使用）

判断フレームワーク

Document Type Selection:
├── Decision needed → ADR
├── Proposal for review → RFC
├── System explanation → Design doc
├── How to operate → Runbook
├── Incident occurred → Post-mortem
├── Process definition → SOP
└── Knowledge capture → Wiki article

主なワークフロー

1. ADR の作成

1. 決定すべき事項を特定する
2. 背景と制約を列挙する
3. 検討した選択肢を列挙する
4. 長所と短所を分析する
5. 決定事項とその根拠を示す
6. 結果を文書化する
7. 関係者によるレビューを受ける

2. RFC プロセス

1. 問題を記述する
2. 解決策の方針を提案する
3. 実装計画を詳述する
4. リスクと軽減策に対処する
5. 成功指標を定義する
6. コメントを受け付ける
7. フィードバックに基づいて反復する
8. 承認または却下に進む

3. 設計ドキュメント

1. 目的と範囲を示す
2. 現状を説明する
3. 提案する設計を提示する
4. 図（C4、シーケンス図）を含める
5. 非機能要件に対処する
6. 検討した代替案を列挙する
7. 展開計画を定義する

ベストプラクティス

• 一貫性を保つためにテンプレートを使用する
• 複雑なシステムには図を含める
• 自分ではなく読者のために書く
• ドキュメントを最新の状態に保つ
• 関連ドキュメントにリンクする
• すべてのドキュメントをバージョン管理する

アンチパターン

アンチパターン	問題	適切なアプローチ
テンプレートがない	ドキュメントに一貫性がない	標準テンプレートを使用する
書きっぱなしのドキュメント	更新されない	レビューを予定に組み込む
背景情報がない	読者が混乱する	背景を含める
冗長すぎる	誰も読まない	簡潔にし、詳細にはリンクする
見つけにくい	ドキュメントが活用されない	整理して索引を付ける