チーム用のドキュメントを書くときに考えてるたったひとつのこと｜cba

「読む人のことを考える」 これだけ。 僕は、ドキュメントを読むのが苦手。すぐに混乱する。 ひとつの段落が長いと混乱する。正確に書いてくれているんだろうけど、書き手目線で細かくばーって書いてあって、読み手がそこから自分の目的の情報を探し出さないといけない状態だと混乱する。 あと、ページの階層が深かったり、リンクでジャンプしまくったり、用語がぶれていたり、文章が複数の意味に捉えられる書き方になっていたりすると、混乱する。 そんな風に、たぶん僕は他の人よりもドキュメントを読むのが苦手なんだと思う。 だから、自分が読んでも混乱しないようなドキュメントを書くと、まわりの人にとっても分かりやすいドキュメントになっているみたい。それで「分かりやすいね」って、ほめてもらって嬉しい。ドキュメントを読むのが苦手で役に立った！ どんなことに気をつけてるかな？と考えてみる。 そのドキュメントの目的が分からないと混

[stabucky]

この文章も読み手のことを考えてくれたのか？ 読みにくかった。