Date

ドキュメントとソースコードの管理って重要じゃないの?

僕はweb系の職場で働いている。
そこには2019年の1月から参加しているんだけど、約1ヶ月経ってみての感想的なものをまとめる。

現職では、ドキュメントがほぼ存在しない。
あったとしても、メモとかExcelでちょこっと書いたレベル。
それはドキュメントじゃない。メモだ。

次にソースコード管理。
2019年の現在、サーバにはFTPでアップロードして、バージョン管理は別名保存でやっている。

やばくね?

ってなってる。
いや、ソースコード管理は1000歩譲って別名保存でもいい。
ただしドキュメント、てめーは別だ。

僕は前職でドキュメントの重要性を徹底的に叩き込まれた。
ソースコードを読まずに、ドキュメントを読めばシステムの全景が把握できるレベル。
そのレベルのドキュメントを書くことの大切さを叩き込まれた。
それが現職ではない。

それはどうなんだ?ってことで、上長に聞いてみた。
そこで帰ってきた回答が、

「ドキュメントを書いている暇がない」

え?
ドキュメントって先に書くもんでしょ?
まずは設計でドキュメント書いて、そこからテスト書いて実装するもんじゃないの?
いや、プロトタイプとかなら設計すっ飛ばして、大まかな流れを考えて(必要なら文字と図にして)
プロトタイプをガーーーって作っていくんじゃないの?
それを書いてる暇がないって…。

なんか、すげーショックだった。
いや、ドキュメントは重要だけどそれだと利益を生まないからある程度にするっていうならわかる。
そうじゃない。
ドキュメントが無いんだ。
他と共有してり、今回の僕みたいに新規にjoinしてきた人へのフォローアップはどうすんの?
いや、まじでドキュメント無いとシステムの全景どころか何も分かんねぇよ!!

慣れたらどうにかなるとかも言われたけど、そんなもんに慣れたく無い。
じゃあどうするか。
選択肢として僕があげたのはこの3つ

  • さっさと辞める
  • ドキュメントを書かないことに慣れる
  • ドキュメントを書く文化を根付かせる

辞めれば楽。めっちゃ楽。
でも、生活とか色々考えたら無理。
あとなんか逃げたみたいで後味悪い。
じゃあドキュメントを書かないことに慣れる?
それもいや。だって、ドキュメントがあることのメリットの方が大きいと信じてるから。
それならやることは一つ。
とにかくドキュメントを書く。
全部で10人ちょっとの会社だ。
ドキュメントがあれば便利。ドキュメントがあってよかった!!っていう文化を根付かせればいい。
いや、めちゃくちゃシンドイ選択だとは思うけど、逆にちょっと変なテンションでワクワクしてる。

体力的にもシンドイかもしれないけど、ソースコード管理を別名保存ってのも僕としてはナンセンスだ。
だから、ソースコード管理も並行していく。
幸い、前職でgitサーバの構築とかやらせてもらった経験がある。
大丈夫、gitサーバくらいすぐに用意できる。
最初はドキュメントのソースコード管理をやってやろうかな。

まとめ

別に1人でもいい。
周りがなにを言ってこようがドキュメントは正義。
ソースコードの管理だって別名ファイルじゃ無い。
バージョンで管理すればいい。
やっていくぞ。