  |
私は長くソフトウェアの業界で技術者として働いていて、ドキュメントを書くべきだって多くの人が言うのを見てきた。それには賛成するものの、過去の経緯や決断、知見を文書にしたところで、私の周りじゃそれを読まない人も多かった。
たとえばBig Tech出身だったりする、業界的には優秀と評されるのであろうエンジニアたちとも仕事をしているけれど、そういう人たちも同じ傾向だ。先日も「なんでこうなってるの？もっとxxすべきだ」って言われたから過去の経緯を説明したら「そういう過去のstoryはドキュメントに残しておいたほうがいい」だと。あのね、正にそのドキュメントあるんですわ・・・知らなかった？ここにドキュメントあるから目を通しておいてねって何度か伝えたよね・・・キミが読んでないだけだよね・・・キミほんといま現在のコードしか見ようとしないもんな。
でも別にこれは彼だけの話じゃない。私はこの業界でずっとそういう、ドキュメントが読まれない風景を見てきている。もうそれを殊更に責める気持ちにはならなくて、ああまたか、と思うだけになった。諦めている。ほとんどの人は読まない。自分が何か具体的な問題に直面し、ドキュメントにその答えがありそうだと人に教わって、ようやくチェリーピックして読む（かもしれない）。それまで資料は見ない。本も読まない。先人の知見や歴史を自分から学んだりはしない。でも例外的にGoogleみたいなキラキラした権威がやってるとされる何かは真似したい人も多いみたい。だってGoogleがやってるんだぜ！クールに決まってる！自分たちとはコンテキストが違うだって？Googleのやってることが役に立たないとでも言うのか？アンタは新しいものが受け入れられないだけだ！おいここに老害がいるぞ！
閑話休題。ドキュメントは書くべきなんだろうけど、ドキュメントを読むべきっていうのももっと言われて然るべきではないのかなとは思う。たとえそれが140字以上の長文であっても。とはいえ、ソフトウェア業界に限らず、手軽に消費できないものを人は読まないというのは一般的な傾向な気がするし、今後も加速していくだろう。もうこれは仕方ないんだろうな。
ソースコードに書けばいいじゃん
ある程度システムを理解した後じゃないとドキュメント読んでも書いてあること理解できないので時間の無駄
「今回の障害の原因を答えてください」 ↓ 「えー」(ホントの原因なんか言えるわけないだろ) ↓ 「ドキュメント類はどうなっていましたか？」 ↓ 「存在しまいたがアップデート...
とても頑張ってプログラム書いたのですが、バグがあったようです 次から気をつけます
IBMとOracleのドキュメントが壊滅的に読みづらいのはなんとかならんかなぁとは思う。 お前の言ってるドキュメント、そのレベルのものじゃないよな？
寝る時に読み聞かせしてあげようか？
19
