エンジニアとして仕事をする中で、ドキュメントを書くということが非常に重要であると度々感じていた。
これまでドキュメントライティングを学んできた中で役に立った記事や書籍、そしてキーワードとおすすめの学習順を紹介する。
キーワード
- ロジカルシンキング
- テクニカルライティング
- 目的思考
- 読む人の視点
参考
書籍
世界一やさしい問題解決の授業
ユーザーの問題解決とプロダクトの成功を導く エンジニアのためのドキュメントライティング
技術者のためのテクニカルライティング入門講座
過去にまとめ記事を書いているので参考まで。
Web 記事
エンジニア歴20数年の私が、設計書を書く際に心がけていること
テクニカルライティングの基本 2023年版
Google社のテクニカルライティングの基礎教育資料がとても良かったので紹介したい
おすすめ順
- 「テクニカルライティングの基本 2023年版」を読む
- 「エンジニア歴20数年の私が、設計書を書く際に心がけていること」を読む
- 必要ならロジカルシンキングについて学ぶ（「世界一やさしい問題解決の授業」など）
- 「エンジニアのためのドキュメントライティング」を読む
- 他に気になったやつを読んで、これまでの知識を補完・アップデートする