テクニカルライティングのすすめ

こんにちは。 SREホールディングス株式会社のエンジニアの高柳です。 エンジニアと言いつつもドキュメントを書くことって多いですよね。 設計書や仕様書はもとより、提案書や報告書なんかのドキュメンテーション業務もざらにあるかと思います。 今回は、「ドキュメント作ってもめっちゃ不毛な添削ばかり😢」「ドキュメント書くの苦手なんだよなぁ」といった方に向けて… それ、テクニカルライティングでちょっとだけ改善されるかもしれません。 テクニカルライティング？ テクニカルライティングとは、技術的な内容を目的や読み手に合わせて分かりやすく伝える手法です。 製品の取扱説明書や論文、ホワイトペーパーなどの技術文書を書く専門の "テクニカルライター" という職業もあるようです。 しかし、かの Google 様曰く、以下のようなお言葉がございます。 確かにエンジニアでも API のリファレンスから技術的な説明まで、

[diveintounlimit]

へーっ