tomevault-io ドキュメントが実装と乖離するのを防ぐため、設計意図→実装調査→差分検出→更新の順で整合性を確保する。設計ドキュメントは変更しない。
フェーズ
- 設計意図抽出 —
docs/internal/を読み、tmp/docs-review/{feature}-intent.mdにWhat/Why/制約を記録 - 実装調査 — 実装ファイル・API・デフォルト値・エッジケースを
tmp/docs-review/{feature}-implementation.mdに記録 - 差分検出 — intent + implementation と現行docsを比較し、差分テーブルを作成
- 更新 — README.md → README.ja.md → docs/guides/ → --help の優先順で更新（設計docsは読み取り専用）
- 検証 —
deno task verify-docs。ファイル追加・削除時はdeno task generate-docs-manifest - 言語 —
*.mdは英語必須、*.ja.mdは日本語（JSR配布対象外）
メモの後処理
低価値→tmp/docs-review/ 削除。PR背景に有用→PR引用。設計記録として保存→docs/internal/changes/ に昇格。
詳細は SEMANTIC-CHECK.md, IMPLEMENTATION-CHECK.md, operational-guide.md を参照。
Converted and distributed by TomeVault — claim your Tome and manage your conversions.