shuntaka
はじめに
shuntaka-dev モノレポの開発ハンドブック・調査・作業記録を管理するドキュメント。日々の調査や作業を 9x に溜めていき、固まったものだけ 0x にまとめる運用にする。
ドキュメントの構成
サマリ
セクション |
中身 |
単位 |
|---|---|---|
開発環境・データベース・運用など「今の開発の仕組み」の断面 |
テーマごとにファイル |
|
本番で起きた障害の記録と対応 |
1 障害 = 1 ディレクトリ |
|
技術調査の記録 |
1 調査 = 1 ディレクトリ |
|
作業の計画と進捗 |
1 作業 = 1 ディレクトリ |
|
未整理の走り書き |
単一ファイル |
01 開発ドキュメント
開発の仕組み・運用（現状）。環境構築・DB スキーマ・運用手順のように、コードとひも付く「今」を書く。採用理由（なぜ）もここに併記する。
96 障害レポート
本番で起きた障害の記録。発生日時・影響・原因・恒久対応をセットで残す。
97 調査メモ
調べて分かったこと。背景・結論・根拠をセットで残す。
98 作業計画 / 記録
やったことと、その場の判断。起票理由＝背景 / 設計方針＝決定 なので、うまく書けば「軽量 ADR」を兼ねる。
99 メモ
未整理の走り書き。固まったら上位のセクションへ移す。
採番ルール（0x と 9x）
系列 |
位置づけ |
採番の向き |
コードとの同期 |
|---|---|---|---|
|
成果物として残す正式ドキュメント |
前から増やす |
保証しない（ある断面のスナップショット） |
|
補助・作業用。障害・調査・作業記録・メモ |
後ろから減らす（ |
時系列の記録なので同期の概念なし |
迷ったらまず 9x（incidents / survey / tasks / memo）に置き、成果物として固まったものだけ 0x に起こす。
警告
0x（開発ドキュメントなど）はコードと同期していない可能性がある。
コードと仕様を常時同期させ続けることは、開発速度を上げるほどコストが見合わなくなる（速度と同期はトレードオフ）。そのため 0x は「常に最新」ではなく、**ある時点の断面（スナップショット）**として扱う。
日々は
97_survey（調査）/98_tasks（作業記録）に、その都度ためていく。開発ドキュメントが必要になったタイミングなど、どこかの断面で
0xを生成・更新する。0xを読むときは、最新の実態は9xとコードにある前提で参照する。