tatsuドキュメントを残さないプログラマーは禿げてしまえ!ツイートシェアはてブLINEPocketどうも、tatsuです(怒)以前、こんなことがありました。後輩tatsu先輩!転さんが作った機能でわからないところがあるので教えてもらえませんか?tatsuどこ?後輩ここの動きって、こういう設定をすればこういう動作するはずですよね?tatsuそうだね、設計書にもそう書いてあるし後輩それが動かないんですよね・・・tatsuえー。転さんが使ってたパソコンにメモが無いか調べてみるよ。—tatsuんー、無いな~。先輩、なにかわかりました?tatsuいや、何も残ってない。なったらソースコードから動きを見るしかなさそうだなー。—tatsuわかったぞー(げっそり)後輩ありがとうございました、助かりました!すみません、前置きが長くなってしまいました。こんな出来事から今回は、プログラマーがドキュメントを書くべき理由について書いていこうと思います!目次ドキュメントは残して!メモ書きでもいいから!メモ書きに残してほしいこと最終手段!最低限!ソースコードのコメントにドキュメントを残さない人の心理めんどくさい時間が無いまとめドキュメントは残して!メモ書きでもいいから!ドキュメント残さない人ってなんなんですかね??自分が作った機能がどんな動きをして、どんな時は正常動作しないのか。知っているのはあなただけなんですよ!あなたがずっといるならいいですよ、聞けるから。あなたが休んだ日は誰も手が付けられないですよね??ましてや転職なんてされたらソースコード解析してドキュメントをおこすしかないわけですよ。メモ書きに残してほしいこと何も詳細な設計書を作れって言ってるわけじゃないです(あるにこしたことはないですが)。メモにでも書いておいてくれればそれだけで全然違うんです!書いておいてほしいのは以下のようなことですね。何ができる機能なのかどんな入力をしたらどんな結果になるのか正常動作しないのはどんな時か特に2番は重要です。どんな値を設定できるのかがわからないとどうしようもないですからね。取りえる値がわかれば1番もなんとなくわかってきますから。最終手段!最低限!ソースコードのコメントに最終手段です。ドキュメントを別で作るのが面倒ならソースコードを読んだ人のためにコメントに書いてください。これはドキュメントというよりかは、いいコードを書くための話になってしまいますが。最低限ですからね!?ドキュメントを残さない人の心理なぜドキュメントを残さないのか。その人の立場になって理由と解決策を考えてみました。めんどくさいまずはこれでしょうね。プログラミングをしててノってるときは手を止めて他のことをしたくありませんからね~。プログラミングがひと段落して休憩にでも行った後、今度はドキュメントの整理をしてほしいです。プログラミングをしているときに別タスクをはさむのは効率が悪いと考えています。これはいろんな方が本や講演で言っているのですが、「マルチタスクは効率が悪い」ってことです。短期間でやることを切り替えるのは脳にとって負担になり、集中できなくなるそうです。プログラミングがひと段落してから休憩をとって、別タスクであるドキュメントを書くのがいいのではないでしょうか??時間が無い期限ぎりぎりでドキュメント書いてる時間ないよー!!って場合。これは、口頭で他の人に引き継ぎをしてください。メモ書きくらいならそんなに時間取られないと思いますけどね。プログラミングに1分でも費やしたい!とかならまあ口頭でもいいでしょう。時間が本当に無かった旨を引き継ぎの人に伝えてくださいね。引き継がれたひとも本当は「いやそれドキュメントにおこしといて」と思っていますから。まとめ普段の愚痴から記事になりそうな内容だったので書いてみましたwあなたはドキュメントをちゃんと書く人ですか?もし今までめんどくさがって書いていないのだとしたら、メモ書きからでいいので残すようにしてほしいと思います。いうのはリスクが大きいですからね。コメントをキャンセルメールアドレスが公開されることはありません。社会人2年目のサラリーマンは格安スマホに変えなさい。RECOMMENDこちらの記事も人気です。