テクニカルライティングをより理解いただくために
技術文書の「書き方」−共通のポイントと各種文書への応用−


機能仕様書および議事録の書き方
−主文で明確に仕様を「宣言」する−

   

機能仕様書は、製品を開発する際の要件をまとめた文書です。機能仕様書では、「主たる視点」によって仕様を明確に指定するのが基本です。また、要件とともに製品の動作を表す際には「主文−補足文」構成が有効です。本セクションでは、機能仕様書とその応用形である議事録をまとめる際のポイントを解説します。

  • 当セクションでは「機能仕様書」を製品を開発する際の文書と位置付け、ハードウェアとソフトウェアで構成される製品を想定して解説します。企業あるいは分野によって「開発仕様書」、「要求仕様書」もしくは「要件定義書」などさまざまに呼称される場合もありますが、当セクションでは「機能仕様書」と総称します。

  • 技術者向けに開発された製品をメーカが提供する際にその機能と使い方を示す文書を「仕様書」と称する場合があります。当コーナーでは、メーカがプログラマにプログラムコンポーネントを提供する際の文書(プログラム開発者向け仕様書)を想定し、以降のセクションで解説します。


機能仕様書見出し構成ポイント

企業では、機能仕様書の書き方の統一を図るため開発する製品の分野に応じた見出し構成の書式が用意されているのが通例です。その点で機能仕様書は、定型の文書であると言えます。

機能仕様書の主旨は、開発にかかわるすべての技術者に開発する製品(新規の開発およびバージョンアップ)が備えるべき要件を決定事項として周知することです。この際、「執筆者による記述もれ」あるいは「読者による見落とし」があっては、その後の開発に支障をきたします。未然に防ぐには、要件を「構造的(書き手・読み手によらない構造)」に表す必要があります。その点で機能仕様書では、段落を文の連なりではなく、文と文との主従関係が明確な箇条書きあるいは表を用いるのが適切です。

機能仕様書の位置付けと一般的な構成


機能仕様書の「主たる視点」と主文

機能仕様書の「主たる視点」は、「(製品をともに開発する)私たち」です。機能仕様書の執筆者は、開発者の代表として決定事項を明確に文書に表す必要があります。その際の基本文体は、「(製品をともに開発する)私たちは」を省略の主語にした能動文です。

機能仕様書の前半で製品の基本要件を表す際は、主文を「宣言文」で表し、必要に応じて箇条書き(あるいは図・表)で補足すると主旨が明確な段落に統一できます。

「開発の概要」の節構成と主文の文体


仕様の指定」と「製品の動作」の表し方

詳細設計の要件を指定する際には、仕様を「宣言文」で指定するとともに、仕様に伴う製品の動作を示す必要があります。この際、「製品の動作(製品は-を動作する)」と「開発者の行為(私たちは-を行為する)」さらには「製品を操作するユーザの行為(ユーザは-を操作する)」が曖昧に混在した文あるいは段落にならないように、分割して構造的に表す必要があります。

「私たちは-を行為する」と「製品は-を動作する」を段落の構造によって分割して表せば、主語を省略しても主体が曖昧になりません。さらに、分割によってそれぞれが明確になるとともに、1文に要約するともれてしまいがちになる重要事項を明確に表せます。

「機能設計」・「仕様変更」を示す段落


議事録ポイント

議事録はビジネス文書の一つですが、「主たる視点」は機能仕様書と同じ「私たち」です。機能仕様書では「(製品をともに開発する)私たち」であるのに対し、議事録では「(議事の決定にかかわった)私たち」です。

議事録と機能仕様書ともに「私たち」を「主たる視点」にした主文を用いますが、両者では補足文の扱い方が異なります。機能仕様書では「製品の動作」を補足文にするのに対し、議事録では重要な発言を発言者名とともに議事録に残す場合があります。ただし、いかに重要な発言であったとしても「決定事項」が主文であり、「個々の発言」は補足文です。

「決定事項」が明確な議事録


次ページに進む(ボタンをクリックしてください)


出張開催形式 テクニカルライティングセミナー

出張開催形式 文書改善研修

技術文書の見直しと執筆 文書作成のポイントをつかむ講座



実践テクニカルライティングセミナー
マニュアル作成の進め方とわかりやすいマニュアルのポイント
Copyright: Takaaki-YAMANOUCHI/1995-2020
山之内孝明/有限会社 山之内総合研究所
Takaaki Yamanouchi/ Yamanouchi Research Institute, Ltd.