技術をわかりやすく伝えるテクニカルライティングのtips

本エントリはZOZO Advent Calendar 2023 シリーズ4の5日目の記事です。 私はDevRelとして、エンジニア向けの社内報でテクニカルライティングtipsを紹介する連載をしています。これまで自分が技術同人誌を書いて校正された経験を元に、少しずつノウハウを共有してみようとはじめました。数ヶ月続けた連載の内容に加筆・修正を加え、まとめたものを本記事で公開します。 一文を短くする 一文は50文字程度までとしましょう。それだけで文章は見違えるほど良くなります。 よくない例 改善したかったのは文のはじまりから結論に至るまでが長く読み手に負担をかけるところで、その改善方法として文を短くすることを紹介しており、これは文の誤りや誤解を招く表現を防ぐ効果もあります。（93文字） 改善例1. 分割する 改善したかったのは一文が長いことです。結論に至るまでが長い文は読み手に負担をかけます。文