Session Documentation Skill
セッションで行った作業・調査・学びをdocs/ディレクトリに構造化されたMarkdownとして記録する。
テンプレート選択
以下のテンプレートから適切なものを選択する:
| テンプレート | 保存先 | 用途 | トリガー例 |
|---|---|---|---|
| default (guide) | docs/guides/ | 手順書・ハウツー | 「ドキュメント化して」「まとめて」 |
| adr | docs/decisions/ | 技術選定・設計判断 | 「ADR形式で」「決定を記録して」 |
| research | docs/research/ | 調査結果・比較分析 | 「調査結果をまとめて」「リサーチを記録」 |
| session-log | docs/sessions/ | 作業ログ・日報 | 「今日の作業をログに」「セッションログ」 |
選択フロー
- •ユーザーの指示からテンプレートを推測
- •明確に判断できない場合 → AskUserQuestionでテンプレート選択を提示
- •何も指定がなければ → **default(guide形式)**を使用
ドキュメント分割ルール
1ファイル = 1トピック を厳守する。
原則
- •1つのドキュメントは1つのジャンル・話題に限定
- •複数のトピックがセッションに含まれる場合は必ず分割して別ファイルにする
- •ファイルが肥大化しないよう、適切な粒度で分ける
分割の判断基準
| 状況 | 対応 |
|---|---|
| 調査A + 調査B を行った | → research/調査A.md と research/調査B.md に分割 |
| 機能実装 + その過程での技術選定 | → guides/機能実装.md と decisions/技術選定.md に分割 |
| 複数の独立した学びがある | → トピックごとに別ファイル |
サイズ目安
- •1ファイル: 100〜300行程度を目安
- •それを超える場合はトピック分割を検討
- •「このファイルは何について書いてある?」に一言で答えられる粒度
例
セッションで以下を行った場合:
- •SF Symbolsのライセンス調査
- •Icon Composerの使い方調査
- •実際のアイコン作成作業
→ 3つのファイルに分割:
- •
docs/research/sf-symbols-license.md - •
docs/guides/icon-composer-usage.md - •
docs/guides/app-icon-creation.md
実行手順
- •
コンテキスト収集
- •セッション内の会話履歴から主要なトピックを抽出
- •
git log --oneline -10で最近のコミットを確認 - •調査で参照したURLをリストアップ
- •
テンプレート選択
- •ユーザー指示に基づいてテンプレートを選択
- •不明な場合はAskUserQuestionで確認
- •
ドキュメント生成
- •選択したテンプレート(
templates/*.md)を参照 - •セッション内容を適切なセクションに配置
- •ファイル名:
{適切な名前}.mdまたは{YYYY-MM-DD}-{title}.md
- •選択したテンプレート(
- •
保存
- •適切なディレクトリに保存(なければ作成)
- •ファイル作成後、パスをユーザーに報告
テンプレートファイル
テンプレートは templates/ ディレクトリを参照:
- •default.md - ガイド形式
- •adr.md - ADR形式
- •research.md - 調査記録形式
- •session-log.md - セッションログ形式
docs/ディレクトリ構造
プロジェクトのdocs/は以下の構造を推奨:
code
docs/ ├── README.md # 目次・説明 ├── decisions/ # ADR ├── guides/ # 手順書 ├── research/ # 調査記録 └── sessions/ # セッションログ
ディレクトリが存在しない場合は作成する。