document について
検証を通過し、承認されたタスク向けのドキュメント段階スキルです。タスク記録、テスト報告、実際の変更ファイルを基に文書更新や再利用可能な教訓の記録を案内し、引き継ぎ前に状態を確認します。
主な機能
- 01検証と承認を前提とする手順
- 02タスクとテスト記録の確認
- 03ドキュメント更新の案内
- 04再利用可能な教訓の記録
- 05引き継ぎ前の状態確認
活用シーン
- 01完了した機能の文書化
- 02動作変更後のユーザーガイド更新
- 03プロジェクト規約の記録
- 04承認済みタスクの引き継ぎ準備
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ eljun/ claude-workflow-skills --skill documentインストール後、Claude Code で/documentを入力して読み込まれたか確認します。
詳細
ドキュメント作成 - ドキュメント作成ステージ
不変条件
- 検証に合格し、ユーザーがタスクを承認した後にのみ実行します。
- タスク文書、テストレポート、実際に変更されたファイルに基づいてドキュメントを作成します。
- 再利用可能な教訓については
LEARNINGS.mdを更新します。 - 安定したプロジェクトレベルの指示がある場合にのみ
AGENTS.mdを更新します。 - 引き継ぎ前に、タスクが
TASKS.mdのApprovedにあることを確認します。前のステージで移動されていない場合は、ここで該当行をApprovedに修正し、トラッカーを再読み込みして確認します。
ランタイムアダプターでは、このステージがスラッシュコマンド、メニューアクション、または自然言語によるスキル呼び出しとして公開される場合があります。移植可能なステージ名は document です。
ワークフロー
AGENTS.mdを読みます。- タスク ID を特定します。
- タスク文書とテストレポートを読みます。
git diff --name-onlyを確認し、実際に変更されたファイルを特定します。- 開発者向けドキュメントが必要な場合は、
docs/features/の機能ドキュメントを作成または更新します。 - ユーザー向けの動作に変更があった場合は、
docs/guides/のユーザーガイドを作成または更新します。 docs/learnings/{ID}-{task-name}.mdに振り返りを記述します。- 既存の項目と重複しないように、再利用可能な教訓を
LEARNINGS.mdに追記します。 - タスクによって長期的に有効なプロジェクトレベルの動作が確立された場合にのみ、
AGENTS.mdを更新します。 TASKS.mdでタスクをApprovedに移動します(testがすでに移動している場合は何もしません。移動されていない場合は、以前のセクションから修正します)。TASKS.mdを再読み込みし、タスクの行がApprovedにあり、Planned、In Progress、Testingにはないことを確認します。行が想定されるセクションにない場合は、移動が漏れています。引き継ぎ前に編集して修正します。
ドキュメント作成の契機
| 変更 | ドキュメント |
|---|---|
| 新しいユーザー向け機能 | 機能ドキュメントとユーザーガイド |
| ユーザーから見える動作を伴うバグ修正 | トラブルシューティングまたはガイドの更新 |
| API または CLI の動作 | 開発者向けドキュメントまたはリファレンスノート |
| 新たに定められた、長期的に有効なプロジェクト規約 | AGENTS.md |
| 再利用可能な教訓や注意点 | LEARNINGS.md |
| テスト設定に関する学び | LEARNINGS.md とテストレポートのメモ |
振り返りのテンプレート
# Task {ID} Retrospective
## Plan Vs Reality
- {What matched or changed}
## Quality Gate Findings
- {What simplify caught}
## Verification Findings
- {What test found}
## Reusable Lessons
- {Actionable lesson}
引き継ぎ
Documentation complete for task {ID}
Task status: Approved
Next stage: ship {ID}
コメント
Markdown 対応