| name | doc |
| description | docs/ ディレクトリへの作業記録ドキュメントを作成・管理するスキル。
/doc で呼び出す。ADR(設計判断記録)、作業プラン、調査メモなどを
所定の形式で docs/ 配下に保存する。
ユーザーが「ADRを書いて」「設計判断を記録して」「作業プランを残して」
「調査結果をまとめて」などと言った場合にこのスキルを使用する。
また、作業中に設計判断や重要な技術的決定を行った場合は、
ユーザーの指示がなくても自律的にこのスキルを使って記録を残すこと。
|
作業記録ドキュメント管理
ファイル配置
docs/
├── adr/ # 設計判断記録
├── plan/ # 作業プラン
├── research/ # 調査メモ
└── (自由に追加)/ # カテゴリは必要に応じて増やしてよい
ファイル名形式
docs/{category}/yyyy-mm-dd_{タイトル}.md
例:
docs/adr/2026-03-05_targettag-system-migration.md
docs/plan/2026-03-05_spotbugs-fix-plan.md
docs/research/2026-03-05_quaternion-api-changes.md
カテゴリ
| カテゴリ | ディレクトリ | 用途 |
|---|
| ADR | adr/ | 設計判断とその根拠。なぜその選択をしたか |
| 作業プラン | plan/ | 実装計画。ステップ、対象ファイル、検証方法 |
| 調査メモ | research/ | 技術調査の結果。API 仕様、ライブラリ比較など |
カテゴリは固定ではない。必要に応じて新しいディレクトリを作ってよい。
サブコマンド
create — ドキュメント作成
/doc create adr "タイトル"
/doc create plan "タイトル"
/doc create research "タイトル"
手順:
- カテゴリとタイトルからファイルパスを生成
- カテゴリに応じたテンプレートで内容を作成
- ファイルを書き出し
list — ドキュメント一覧
/doc list
/doc list adr
手順:
docs/ 配下を Glob で検索
- カテゴリ別に一覧表示
テンプレート
ADR
# {タイトル}
## ステータス
承認済み / 提案中 / 廃止
## コンテキスト
何が問題だったか、どういう状況だったか。
## 決定
何をどうすることにしたか。
## 根拠
なぜその決定をしたか。検討した代替案とその却下理由。
## 影響
この決定によって何が変わるか。
作業プラン
# {タイトル}
## 概要
何をするか、なぜするか。
## ステップ
1. ...
2. ...
## 対象ファイル
- ...
## 検証方法
- ...
調査メモ
# {タイトル}
## 背景
なぜ調査したか。
## 調査結果
...
## 結論
...
注意事項
- ドキュメントは日本語で書く
- テンプレートはガイドラインであり、内容に応じて自由に調整してよい
- 既存の docs/ 配下のファイルは旧形式のため、新規作成時にこの形式に従う