📚

「エンジニアのためのドキュメントライティング」読んだ

2023/03/21に公開

どんな内容？

わかりやすいドキュメントとは？どうやって書くのか？が丁寧に書かれていた。
また、ドキュメントの品質が測定可能なものとして定義されていて、これを読めば ”何故このドキュメントが必要なのか、あるいは用をなせてないのか” が明確に説明できるようになる内容だった。

Forkwellのイベントの翻訳者iwashiさんの登壇の中でドキュメントにもビルドトラップがあるというお話があって、価値を生み出せていないドキュメントの棚卸しもできる基準が書かれているのがよかった。

あとはこれを一通りやろうと思ったときに「大変・・・」とつい思ってしまう気持ちを解消できるような方法が書かれているとさらに嬉しい。
それはchatGPTがなんとかしてくれるのかもしれないけど。

iwashiさん「多くの開発者にとってドキュメントを書くことはどうしてこんなに大変なのでしょうか？」
Sarahさん「私が思うに、どうしてドキュメントを書くのが開発者にとってこんなに大変なのかというと、ドキュメントを書くことは誰にとっても大変だからです😊」
（超意訳）

ということなので「エンジニアのための」というタイトルではあるけど、職種に限らず幅広く参考になる本だと思う。

「誰が書いたんだよ、これ」と考えて気分が沈んでいく中、14 か月前に書いた自分のコードだったことに気づく。「全然覚えてない」

冒頭のここに笑った。
いつも未来の自分のためにドキュメントを書いているところある。全然覚えてないから。

fukabori.fmの対談の中でEmpathyがキーワードとしてあがっていて、普段「シンパシー」の方がよく聞くけど「Empathy！！そ、それだ・・・」とぐっときた。