🐷
ドキュメントの構成管理
ドキュメントの構成管理をするモチベーション
システムの構成管理をしよう！
コードの管理だけだと片手落ち
その仕様書っていつのもの？今のコードとあってる？
ドキュメントの版が確認できないと困る！
管理の要件
- いつ、だれが、何を、なぜ変更したかがわかる
- 過去の版と比較できる
- 上記が楽だと嬉しい
管理方法
Gitで管理
- how: plaintextをcommit, PR, マージする
- pro: いつだれがなにを、という変更がわかりやすい
- pro: ソースコードとの紐付けが行える
- pro: ドキュメントレビューの仕組みを取り込みやすい
- con: plaintext以外のものは管理しにくい（Officeなど)
- con: 非エンジニアにとってハードルが上がる
- con: クライアント等と共有しにくい
Dropboxで管理
- how: Officeドキュメントなどに変更履歴ページを作る
- how: 版ごとに別ファイルとして保存する
- pro: 学習コストが低い
- pro: 外部共有がしやすい
- con: 差分を比較しにくい
- con: ファイルが増える
- con: ルールと手作業に依る要素が大きい
Google Driveで管理
- how: googleドキュメント, スプレッドシートの変更履歴、版管理を用いる
- pro: 学習コストが低い
- pro: ファイルが一つ
- pro: 外部共有がしやすい
- con: 過去の版が消える可能性がある
- con: 共同編集のコンフリクト、ファイルを分割すると履歴が終えない
NotePMで管理
- how: NotePMに記載
- pro: plaintextが基本だがファイル添付が可能
- pro: ページごとに外部共有が可能
- con: 有償
その他のツール
- 個々に検討が必要
Discussion