読みやすいドキュメントを書くために今日からできる7つのこと
こんにちは。壮(@sew_sou19)と申します。
メガベンチャー企業でエンジニアとして働いています。
エンジニアにジョブチェンジした当初は、ドキュメントの書き方なんてこれっぽっちも分かりませんでした。読みやすいドキュメントを書くことが本当に苦痛だったのですが、考えて、試行錯誤し続けた結果、以下のような評価を得るに至りました。
そこでこのnoteでは、僕がドキュメントを作成するときに、特に意識して実践している7つのことを書きます。(本当は2万文字ほどお伝えしたいことがある