質の高い技術文書を書く
https://blog.riywo.com/2021/01/how-to-write-high-quality-technical-doc/
結論
文書から得られるアウトプットが明確で、読み手のレベルによらず一定に伝わること
文書を書き始める前にすること
文書から得られるアウトプットをまず定める
アウトプットは課題の定義から始める
文章を書きながらすること
読み手を常に想像する
文章の目的を冒頭に簡潔に書く
hiroki.icon文章自体の存在意義を説明するわけだからメタ的要素
アウトプット(結論)を先に書く
具体的な数値で文章を説明する
速くなる、ではなく、100msから10msになります
箇条書きを濫用しない
細部にまで目を配る
文書を読んだ後の議論をスムーズにするために
選択肢は可能な限り網羅する
hiroki.icon列挙思考だな
One-way doorとTwo-way door
自分の意見を表明する
長くなりすぎない
/icons/hr.icon
/ohbarye/技術文書に関するガイド