stackbook

← 辞書(分野別)

§17

ドキュメント・設計

最終確認:2026年9月

設計判断の記録
ADR(`docs/adr/0001-xxx.md`)
図
Mermaid(GitHubでそのまま描画される)
  • D2レイアウトを細かく制御したいとき
  • draw.io非エンジニアと共同編集するとき
ER図
tbls(実DBから自動生成)
APIドキュメント
開発者向けドキュメントサイト
READMEに必ず書くこと
セットアップ手順、主要コマンド、環境変数一覧、デプロイ方法、連絡先