ITエンジニアといえどコードを書くだけでなく、ドキュメント作成やコミュニケーションをとるときなど文章を書く場面があります。文章による伝達が上手にできると、無駄なコミュニケーションのコストが減るし、よりコードを書いたりすることなどに時間が割けるので、身につけておくべきスキルと私は感じています。
技術文書の作成方法について、「テクニカルライティング」と呼ばれています。下記の記事にテクニカルライティングが必要な状況等、取り上げられていますが、技術的な成果について非エンジニアに説明するのは中々骨が折れるし、理解もしてもらいづらいかなと思います。ので、いかに相手に伝えるかというスキルが必要になってくるわけです。
【成果を生み出すテクニカルライティング ―トップエンジニア・研究者が実践する思考整理法】
https://gihyo.jp/book/2019/978-4-297-10406-1/content/preface
テクニカル・ライティングが対象とする範囲ですが、技術関連の論文やレポートを対象とするのが狭義の意味ですが、最近は『正確かつ効果的に伝達するための文書作成技法』という解釈で使われていることもあるそう。なので、エンジニアのみならずビジネスに関わる人なども学ぶべき領域なのかなと。
【テクニカル・ライティングとは】
http://www.logicalskill.co.jp/writing/tw.htm
具体的にどのように文章を作成すれば良いか、下記の記事で触れらています。基本的には結論から書くことを意識して、短時間で相手が理解できるように心がけると良いかなと思います。結論・その理由・エビデンスが揃っていると、けっこう論理的な文章に見えたりすると感じます。
【実用文で「起承転結」はNG！ 伝わりやすいテクニカルライティングを実践する4つのコツ】
https://codezine.jp/article/detail/11196
