「あなたが、これから作ろうとしている文書の、読者は誰ですか?」
これは、非常に大事なことです。しかも、非常におろそかにされやすい点です。TCの基本中の基本「読者を明確にする」です。読者が明確になって、はじめて「正確な技術的情報の伝達」が可能になります。
読者が明確になったら、文書の冒頭で以下の項目を明記します。
(1)この文書が対象とする読者
技術文書は、何かの情報を得るために読みます。誰がどんな情報を得られるかを、文書の最初に記述します。
例)・この文書は、TC技術を学ぶSE、プログラマが対象です。
・本書は、技術文書を作成する、ソフトウェア技術者が対象です。
(2)この文書を読むのに必要な知識
文書を読むために必要な、前提知識を明記します。これがないと、どんなに素晴らしい文書でも、次のような不評を買います。
「専門用語ばかりで、わけがわからない」
「当たり前のことが多すぎて読みにくい」
読者が、情報過多や情報不足に陥らないために、読む人の知識レベルを明記します。
例)・このテスト計画書は、○○−CADの操作方法に関する知識を前提とします。
・この詳細仕様書は、「△△システム 基本仕様書」を元に記述します。
・本書は、Cによるプログラミングの知識を前提としています。
・本書の理解には、FORTRAN文法の知識が必要です。
−・−