🐺

TECHNICAL WRITING の参考記事まとめ

2023/10/28に公開

はじめに

進捗報告やプレゼンなど報告を行う機会は多いかと思います。
報告を行うためには思考整理し、言語化を行う必要があり
言語化がうまくできていないと、相手に伝わりづらい内容になってしまいます。

実際にこのような経験をした人は私だけではないはず。

そこで今回は、思考整理の手法としてTECHNICAL WRITINGを簡単に紹介しつつ、
参考文献もまとめていきますので是非ハブページとしてお使いいただければと思います。

本記事では下記の方向けにまとめております。

一般的には技術的な内容を目的や読み手に合わせて分かりやすく伝える手法と言われています。

報告書、提案書、議事録、マニュアルと言った
業務の中で技術文書を作成する機会はたくさんあると思いますので
生産性を上げるには重要なスキルの1つです。

課題を見つけるときも、言語化してはじめて理解できるものとなります。

特にエンジニアや研究者は普段から言語化を行うことが多いため
優れた課題を見つける上でも重要なスキルではなかろうかと思います。

ありがたいことに
すでに世の中には沢山の文献があるので
今回はそちらをまとめていきます。
※他にも気になる記事があれば随時更新予定です。

技術者向け

一般向け

テクニカルライター

今回TECHNICAL WRITINGという手法を学んでいきましたが
思考整理の手順を軽視していたなと感じました。

思考整理に必要な「背景・前提」「課題」「手段・アプローチ」「結果・分析」が立体的になっていることを意識できていなかったことが原因で思考整理に必要以上な時間を投資していた気がします。

私自身もまだまだ学び途中ではありますが、
少しでも興味や解消につながるきっかけになると嬉しい限りです。