テクニカルライティングに関する読み物

他人の書いたソースコードをみて学べという話はよく聞くが、他人の書いた設計書等をみながら日本語の書き方を学べ、という話はそれほど多くは聞かない。ただ、曖昧な表現をするなという話を聞いたことがない方はいらっしゃらないだろう。

ソフトウェア開発に限定されないが、技術文書を書くことはテクニカルライティングと呼ばれている。テクニカルライティングでは、事実を読者にわかりやすく伝えることに主眼がおかれている。事実を淡々と書くというと一見簡単そうだが、実際には曖昧さ、モレがないドキュメントを書くのは難しい。意図せず、読者を誤解させるような文章を書いた経験は誰にでもあるだろう。

このエントリではテクニカルライティングに参考になる読み物があるので紹介する。昨年の6月からgihyo.jpではじまった松下 健次郎氏の「Webゆえに考える テキスト編集のテクニカルコンセプト」の連載だ。いくつかは、Webサイトの文書作成に特化した形で書いてあるが、以下の回は一般的なテクニカルライティング（ソフトウェア開発で作成するドキュメント）にも活用できる。

• 「可読性を高める」(1), (2), (3)
• 「書きやすい環境を作るための事前確認」
• 「日々のトレーニングを習慣づけよう」

「可読性を高める」に書かれていることは、比較的短時間で実行に移せることが多い。どのあたりが、ご自身のソフトウェア開発のドキュメント品質の向上に活かせるだろうか。