履歴・記録
作業ログの残し方。
履歴・記録の残し方
「誰が・何を・どの粒度で読むか」を決めると、履歴の残し方がブレない。正本の置き場所は リポジトリ — docs / 作業履歴 を参照。
flowchart TD
PR[PR / merge commit] --> Git[Git log]
Docs[docs/ 公式] --> Onboard[新メンバー onboarding]
ADR[docs/adr/] --> Onboard
Zdocs[z_docs/history/ 任意] --> Self[個人振り返り]
Chat[チャット履歴] --> Handoff[引き継ぎ]
Git --> Handoff
Docs --> Handoff
下表は記録の置き場所と粒度の早見。
| 記録の種類 | 粒度 | 誰が読むか | 正式な記録性 |
|---|---|---|---|
| Git log | コミット単位 | レビュアー・将来の自分 | 高 |
| docs/ | 機能単位 | チーム全体 | 最高（公式） |
| docs/adr/ | 意思決定単位 | 設計レビュアー | 高 |
| z_docs/history/ | セッション単位 | 本人 | 任意 |
| チャット | 1 チャット = 1 タスク | 引き継ぎ先 | 補助 |
Git log
TDD 採用チームは [RED] / [GREEN] / [REFACTOR] プレフィックスを使うと読みやすい。
* [REVIEW] address review comment: handle null in <field>
* [REFACTOR] extract _<helper> to private method
* [GREEN] implement <usecase>
* [RED] add failing tests for <usecase>
* docs: add docs/<feature>/ design docs + ADR-NNNN
* [PLAN] refine task breakdown before implementation
* feat: <user-visible summary> (merge commit)
docs/ (公式)
- 要件・設計・DB・技術選定・テスト計画・ログ・デプロイが揃う
- 重要な意思決定は docs/adr/ に切り出す
- 共有したい知見は z_docs から docs/ へ昇格させる
履歴の置き場
作業履歴（Obsidian 正本 · z_docs 任意）
詳細・判断フロー: リポジトリ — docs / 作業履歴
- 必要なときだけ、フェーズ別意思決定を時系列で残す
- 後から自分で振り返りたいときの補助
- 共有したい知見だけ docs/ や PR に昇格すればよい
チャット履歴
- 各フェーズの冒頭で「フェーズN: 目的」を宣言
- 長くなったら新規チャット。
@Past Chatsで必要分だけ引き継ぐ（4章 会話の文脈管理） - 引き継ぎ時、後任者が PR と履歴を読めば理解できる状態にする