成果を生み出すテクニカルライティング(セイカ オ ウミダス テクニカル ライティング)

コードは書けるのにドキュメントになると手が止まる。仕様書、設計書、 API リファレンス、障害報告 - エンジニアが書く文書は多岐にわたるのに、その書き方を体系的に学ぶ機会は驚くほど少ないのが実情です。本書はテクニカルライティングの原則を「成果につながる」という視点で整理し、読み手が迷わず行動できる技術文書を書くための手法を示します。

扱われる範囲は文章の構成原則、パラグラフの組み立て方、用語の統一、図表の使い方、レビューの受け方・出し方に及びます。抽象的な「分かりやすく書きましょう」で終わらず、「一文一義」「結論先行」「主語と述語の距離を縮める」といった具体的な技法を、悪文の改善例とセットで提示する構成です。

プログラマ向けの文章術としては他にも選択肢がありますが、本書は日本語の技術文書に焦点を絞っている点で実務との距離が近く、翻訳書にありがちな「英語話者向けの例文が日本語の文脈に合わない」問題がありません。新人エンジニアが最初に読んでも、ドキュメントの質に課題を感じているチームが輪読しても、書く力の底上げに直結する実用書です。