Excel設計書からの脱却案

はじめに

地方でSIerをしています。以前からQiitaで情報を集めていましたが、
何かしらアウトプットをしようと思い記事を書くことにしました。
Qiitaの投稿に不慣れなため、何か気になる点があればご指摘いただけると嬉しいです。

現在の運用

言語はC#、IDEはVisual Studio 2017。
設計書はExcel方眼紙で作成しており、サーバー上に共有し管理しています。
ソースファイル(とソリューションファイル)はgitで管理しています。
設計は別のメンバーが行うこともあれば、コーディング担当者が行うこともあります。
設計に関わるメンバーにはいずれも開発環境があります。

現在の問題点(解決したい課題)

• 編集したいタイミングで誰かが開いていたら待ち時間が発生する。
  (あるいは、閉じてもらうようお願いする作業が発生する。)
• 変更が入るたびに罫線などのレイアウトを変更しなければならない。
• 場合によっては印刷後のことも考慮して調整したりしなければならない。
• 変更履歴は別シートで管理しているが、その記載も漏れなく行う必要がある。
• 変更点のメンテ以外のこういう本質的ではない作業は無駄であるし、面倒くさい。

脱却案

ソリューションファイル内にMarkdownファイルを含めて、まとめてバージョン管理する。

これで、上記の問題点は解消できると思います。
具体的には、「Documents」などのフォルダを作って、そこにコーディング規約¹や設計書をすべて保存するようにします。

こうすることにより、

• 任意のタイミングで設計書のメンテを行える。
• 罫線などレイアウトを考慮する必要がなくなる。
• バージョン管理に含めることにより、コミットメッセージで変更点を的確に記載できる。また、履歴も一目瞭然である。

といったメリットを得ることができるかと思います。
また、ソリューションファイル内に含めることにより、サーバーの設計書を開いて修正→ローカルでソース修正ではなく、ローカルで設計書もソースも変更でき、集中力も途切れにくいかな…といった思惑もあります。

懸念点

• 設計書が納品物に含まれている場合、特に指定されていない場合でも暗黙的にExcelを要求されることが多いかも…。
• 生のMarkdownでは納品できない場合、HTMLやPDFに変換する作業が発生する。どうしてもExcelでなければならないならExcelに変換する。
• (私も含めて)Markdownで設計書レベルのことをしっかり記載できるか。メンバーのスキルの問題。
• Markdownでも画像や表を扱えはするものの、ドキュメントとしての単純な表現力ではExcelの方が優れている。

ぱっと上記の点が思い浮かびますが、他にもあるかもしれません。
が、少なくとも上記の点に関しては、デメリットよりもメリットの方が大きいかなと思っています。

まとめ

とりあえず、趣味で書いているプログラムはこの運用で行っていますが、それで開発が捗りそうであれば打診してみようと思います。
むしろ上に説得してその気にさせるのが一番大変なのですが…。

今回の脱却案以外に、もし他に良い案や「うちではこうやってるよ」などがありましたら、教えていただけると嬉しいです！

その他

ブログとCrieitでも記事を公開しているので、よければご覧ください。

ブログ：BOYISH KINGDOM

Crieit：apashoni

1. コーディング規約は個々人が好き勝手に変更できないように、PDFなどで配布するのもアリかと思います。いずれにせよ、「ローカルで参照できる」のが理想だと思います。 ↩