はじめに
半分夢物語みたいなものなので、参考程度にお願いします。
内容に関するはじめに
皆さん案件に携わっている中で、設計書を見たことがあると思います。
よく見るのはExcelで作られたヤツ。
で、このExcelで作られた設計書にある大きな欠点が、バージョン管理のしづらさです。
gitやsvnで差分を見てもわけがわからないし、新しく書き足そうと思うたびにバックアップを取って、名前にyyyyMMddHHmmssをつけて・・・というのもちょっとアレです。アレ。
これを解決する案が「変更箇所のみ赤字にしておく」ですが、これもちょっと微妙です。
例えば「20シートくらいあって」「場所によって色々な文字色が使われている」設計書があった場合、設計書に1行書き足したいだけなのに前回赤字にされた部分を直す作業でめちゃくちゃ時間を食います。
それと、この仕様にした場合強調したい箇所などに赤字が使えなくなります。
さあ困った。
考えてみた
Markdown + バージョン管理ツール
良いところ
- Markdownなので表現の仕方にある程度の自由さはある。
- バージョン管理ツールなので、差分確認だけでなくコミットコメントも残せる。
また、任意のタイミングで差分を保存出来る。 - Excelのときと同じように、PJ用のフォルダに設計書を置ける。
悪いところ
- 扱いやすさ/書きやすさは、やっぱりExcelには敵わない。
- 「シート分け」に対応する概念がないため、ファイルを分ける等の手間がかかる。
- Markdownエディター かつ バージョン管理ツールのコミットもできるようなアプリがほぼない。
（VSCodeのようなIDEにアドオンでMarkdown対応させるくらい・・？）
Googleスプレッドシート
良いところ
- かなりExcelに近い使い方が出来る。
- その上で差分もしっかり確認できる。
- xlsxファイルで出力出来るので、社外などにも共有しやすい。
悪いところ
- 設計書をPJ用フォルダに配置出来ない。（ショートカットリンクを置くくらいしかない・・？）
- 差分を保存するタイミングが自動のため、かなり細かく残ってしまったりする。結果見づらい。
- バージョンごとのコメントが残せないため、パッと見たときにどこがどの差分かわからない。
- 設計書の権限管理が面倒くさい。
共有リンクを一度知られたら、明示的にブロックしたりリンクを更新しない限り恒久的にアクセス出来るため、案件用フォルダと各設計書を二重で管理する必要が出てくる。 - 作成者が案件から外れるたびに管理者を変えたりする必要が出てくる。
おわりに
どれも一長一短ありますが、短所がそこそこでかいのが悩みどころです。
Markdown + バージョン管理ツールが比較的マシだとは思いますが、どうしても扱いにくさが否めない・・。
とはいえ、完全手動のバージョン管理もかなりしんどいので、できればこっちにしたいよなぁという気持ちが個人的には強いです。
この話をするのにあたって一番の短所は、そもそも乗り換えるという事自体のハードルがめちゃくちゃ高いということですが。
なにかいいアイデアがあればコメントお願いします！