見出しを5W1Hにするとわかりやすいドキュメントがかけそう

見出しを5W1Hにするとわかりやすいドキュメントがかけそう。読む人の知りたいことを言語化するとなぜ・なに・なんのためのような形になると思うで読む人にとっては負荷が低くなりそう。

見出しがWhat, How, Whyの例 https://simperium.com/overview/

あと、例を書くときに目立つようにDO / DON'T をつけるとわかりやすい。「何々をしてください」 「何々をしないでください」 と書かれるとちゃんと読まないと反対の意味に取ってしまう。 やる・やらないを目立つように書いて、さらに色や記号で使っていると一瞬でわかってありがたい。

わかりやすいDO / DON'Tの例 https://material.io/components/app-bars-top#anatom

読者の負荷をどのように下げるかと言うことを考えるとわかりやすいドキュメントが作れそうだ。