ドキュメントを残さないプログラマーは禿げてしまえ!

どうも、tatsuです(怒)

以前、こんなことがありました。

 

転職する人
それでは今までありがとうございました!
私&皆
がんばってなーー!
転職する人
はい!またどこかで!

 
— しばらくして —
 

後輩
私先輩!転さんが作った機能でわからないところがあるので教えてもらえませんか?
どこ?
後輩
ここの動きって、こういう設定をすればこういう動作するはずですよね?
そうだね、設計書にもそう書いてあるし
後輩
それが動かないんですよね・・・
えー。。設計書にはそう書いてあるし.. 転さんが使ってたパソコンにメモが無いか調べてみるよ

 
— 転さんのパソコンにて —
 

んー、無いな~。
後輩
先輩、なにかわかりました?
いや、何も残ってない。こうなったらソースコードから動きを見るしかなさそうだなー。
後輩
おなしゃす!!!
お、おい!w 俺かよww

 
— 30分後 —
 

わかったぞー(げっそり)
後輩
ありがとうございました、助かりました!

 
すみません、前置きが長くなってしまいました。

こんな出来事から今回は、プログラマーがドキュメントを書くべき理由について書いていこうと思います!

ドキュメントは残して!メモ書きでもいいから!

ドキュメント残さない人ってなんなんですかね??

自分が作った機能がどんな動きをして、どんな時は正常動作しないのか。
知っているのはあなただけなんですよ!

あなたがずっといるならいいですよ、聞けるから。

でもあなたが休んだ日は誰も手が付けられないですよね??
ましてや転職なんてされたらソースコード解析してドキュメントをおこすしかないわけですよ。

メモ書きに残してほしいこと

何も詳細な設計書を作れって言ってるわけじゃないです(あるにこしたことはないですが)。
メモにでも書いておいてくれればそれだけで全然違うんです!

書いておいてほしいのは以下のようなことですね。

  1. 何ができる機能なのか
  2. どんな入力をしたらどんな結果になるのか
  3. 正常動作しないのはどんな時か

 
特に2番は重要です。
どんな値を設定できるのかがわからないとどうしようもないですからね。

取りえる値がわかれば1番もなんとなくわかってきますから。

最終手段!最低限!ソースコードのコメントに

最終手段です。最低限です。

ドキュメントを別で作るのが面倒ならソースコードを読んだ人のためにコメントに書いてください。

これはドキュメントというよりかは、いいコードを書くための話になってしまいますが。。

あくまで最低限ですからね!?

ドキュメントを残さない人の心理

なぜドキュメントを残さないのか。
その人の立場になって理由と解決策を考えてみました。

めんどくさい

まずはこれでしょうね。

プログラミングをしててノってるときは手を止めて他のことをしたくありませんからね~。

でもプログラミングがひと段落して休憩にでも行った後、今度はドキュメントの整理をしてほしいです。

ポイントは休憩後。
やはりプログラミングをしているときに別タスクをはさむのは効率が悪いと考えています。

これはいろんな方が本や講演で言っているのですが、「マルチタスクは効率が悪い」ってことです。

短期間でやることを切り替えるのは脳にとって負担になり、集中できなくなるそうです。

なので、プログラミングがひと段落してから休憩をとって、別タスクであるドキュメントを書くのがいいのではないでしょうか??

時間が無い

期限ぎりぎりでドキュメント書いてる時間ないよー!!って場合。

これは、口頭で他の人に引き継ぎをしてください。

でもメモ書きくらいならそんなに時間取られないと思いますけどね。
プログラミングに1分でも費やしたい!とかならまあ口頭でもいいでしょう。

ですが時間が本当に無かった旨を引き継ぎの人に伝えてくださいね。
引き継がれたひとも本当は「いやそれドキュメントにおこしといて」と思っていますから。

まとめ

普段の愚痴から記事になりそうな内容だったので書いてみましたw

あなたはドキュメントをちゃんと書く人ですか?

もし今までめんどくさがって書いていないのだとしたら、メモ書きからでいいので残すようにしてほしいと思います。

その人しか知らない っていうのはリスクが大きいですからね。

それでは!

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です