わかりやすい技術文書へのアプローチ：技術文書の「書き方」－共通のポイントと各種文書への応用－

<BODY BGCOLOR="#ffffff" LINK="#ffffff" VLINK="#ffffff"> <P> <img border="0" src="fig-t00/gb-bar-introduction.gif" width="540" height="26" alt="わかりやすい技術文書へのアプローチ"><BR> <img border="0" src="fig-t00/tgb00-ttl.gif" width="570" height="150" alt="技術文書の「書き方」－共通のポイントと各種文書への応用－"><HR> <H1 style="line-height: 150%"><span style="font-weight: 400; letter-spacing: -1pt"> <font color="#800000">機能仕様書</font>および<font color="#800000">議事録</font>の書き方<br> </span> <span style="font-weight: 400"><font size="5" color="#000080">－主文で明確に仕様を「宣言」する－</font></span></H1> <div align="center"> <center> <table border="0" cellspacing="0" width="75%" style="border-collapse: collapse" bordercolor="#111111" cellpadding="0"> <tr> <td width="10" bordercolor="#000000" bgcolor="#008080" bordercolorlight="#FFFFFF" bordercolordark="#FFFFFF">　</td> <td bordercolor="#000000" bgcolor="#FFFFFF" bordercolorlight="#FFFFFF" bordercolordark="#FFFFFF"> <p align="left" style="line-height: 150%; margin: 0 10"> 機能仕様書は，製品を開発する際の要件をまとめた文書です．機能仕様書では，「主たる視点」によって仕様を明確に指定するのが基本です．また，要件とともに製品の動作を表す際には「主文－補足文」構成が有効です．本セクションでは，機能仕様書とその応用形である議事録をまとめる際のポイントを解説します．<ul type="circle"> <li> <p align="left" style="line-height: 150%; margin-left:10; margin-right:10; margin-top:0; margin-bottom:7"> <font color="#008080">当セクションでは「機能仕様書」を製品を開発する際の文書と位置付け，ハードウェアとソフトウェアで構成される製品を想定して解説します．企業あるいは分野によって「開発仕様書」，「要求仕様書」もしくは「要件定義書」などさまざまに呼称される場合もありますが，当セクションでは「機能仕様書」と総称します．</font></li> <li> <p align="left" style="line-height: 150%; margin-left:10; margin-right:10; margin-top:0; margin-bottom:7"> <font color="#008080">技術者向けに開発された製品をメーカが提供する際にその機能と使い方を示す文書を「仕様書」と称する場合があります．当コーナーでは，メーカがプログラマにプログラムコンポーネントを提供する際の文書（プログラム開発者向け仕様書）を想定し，以降のセクションで解説します．</font></li> </ul> </td> </tr> </table> </center> </div> <HR> <H3><FONT COLOR="#800000">機能仕様書</FONT>の<font color="#800000">見出し構成</font>と<FONT COLOR="#800000">ポイント</FONT></H3> <p style="margin:1 10; line-height: 150%; "> 企業では，機能仕様書の書き方の統一を図るため開発する製品の分野に応じた見出し構成の書式が用意されているのが通例です．その点で機能仕様書は，定型の文書であると言えます．</p> <ul> <li> <p style="line-height: 150%; margin-top:0; margin-bottom:15"> <font color="#000080"> 前半を概念設計・基本設計を集約した章構成とし，後半は各開発単位（機能あるいは構成部分）で章を構成し詳細な要件を示す例が多く見られます．</font></p> </li> </ul> <p style="margin:1 10; line-height: 150%; "> 機能仕様書の主旨は，<font color="#800000">開発にかかわるすべての技術者に開発する製品</font>（新規の開発およびバージョンアップ）<font color="#800000">が備えるべき要件を決定事項として周知</font>することです．この際，「執筆者による記述もれ」あるいは「読者による見落とし」があっては，その後の開発に支障をきたします．未然に防ぐには，要件を「構造的（書き手・読み手によらない構造）」に表す必要があります．その点で，機能仕様書には段落を文の連なりではなく，文と文との主従関係が明確な箇条書きあるいは表を用いるのが適切です．</p> <ul> <li> <p style="line-height: 150%; margin-top:0; margin-bottom:15"> <font color="#000080"> 細部の事項のもれであっても重大な支障をきたす場合があります．執筆者は定型の見出し構成に沿って機能仕様書を作成しているはずですが，意外にもれがあると聞きます．見出しには沿っていても，執筆者が主たる事項と補足的な事項を1文にひとまとめしているのが一因と言えます．</font></p> </li> <li> <p style="line-height: 150%; margin-top:0; margin-bottom:15"> <font color="#000080"> また，もれなく書かれてあっても，主たる事項と補足的な事項がひとまとめでは，読者が読みもらす可能性があります．「主文－補足文」構成を基本にして要件を構造的に表す工夫が必要です．</font></p> </li> </ul> <p align="center"> <img border="1" src="fig-t00/tgb0004a.jpg" vspace="10" width="480" height="360" alt="機能仕様書の位置付けと一般的な構成"></p> <hr> <H3><FONT COLOR="#800000">機能仕様書</FONT>の「<FONT COLOR="#800000">主たる視点</FONT>」と<font color="#800000">主文</font></H3> <p style="margin:1 10; line-height: 150%; "> 機能仕様書の「主たる視点」は，「<font color="#800000">（製品をともに開発する）私たち</font>」です．機能仕様書の執筆者は，開発者の代表として決定事項を明確に文書に表す必要があります．その際の基本文体は，「（製品をともに開発する）私たちは」を省略の主語にした能動文です．</p> <ul> <li> <p style="line-height: 150%; margin-top:0; margin-bottom:15"> <font color="#000080"> 「（私たちは）ある性能を達成する」もしくは「製品を＊＊に対応とする」，「＊＊に＊＊を追加する」などいずれも「これから製品をある仕様にする」を主旨にした「宣言文（これから-する）」です．</font></p> </li> </ul> <p style="margin:1 10; line-height: 150%; "> 機能仕様書の前半で製品の基本要件を表す際は，主文を「宣言文」で表し，必要に応じて箇条書き（あるいは図・表）で補足すると主旨が明確な段落に統一できます．</p> <p align="center"> <img border="1" src="fig-t00/tgb0004b.jpg" vspace="10" width="480" height="360" alt="「開発の概要」の節構成と主文の文体"></p> <hr> <H3>「<FONT COLOR="#800000">仕様の指定</FONT>」と「<FONT COLOR="#800000">製品の動作</FONT>」の表し方</H3> <p style="margin:1 10; line-height: 150%; "> 詳細設計の要件を指定する際には，<font color="#800000">仕様を「宣言文」で指定するとともに，仕様に伴う製品の動作を示す</font>必要があります．この際，「製品の動作（製品は-を動作する）」と「開発者の行為（私たちは-を行為する）」さらには「製品を操作するユーザの行為（ユーザは-を操作する）」があいまいに混在した文あるいは段落にならないように，分割して構造的に表す必要があります．</p> <ul> <li> <p style="line-height: 150%; margin-top:0; margin-bottom:15"> <font color="#000080"> いずれも述語が「-する」の能動文のため，文構成によっては「誰が-する」のかあるいは「何が-する」のかが誤解されて伝わるおそれがあります．</font></p> </li> </ul> <p style="line-height: 150%; margin: 1 10"> 「私たちは-を行為する」と「製品は-を動作する」を段落の構造によって分割して表せば，主語を省略しても主体があいまいになりません．さらに，分割によってそれぞれが明確になるとともに，1文に要約するともれてしまいがちになる重要事項を明確に表せます．</p> <ul> <li> <p style="line-height: 150%; margin-top:0; margin-bottom:15"> <font color="#000080"> この際，製品を操作するユーザは仮想的な存在ですから，あえて省略せず｢ユーザは-を操作する」と主語を明示するのが適当です．</font></p> </li> </ul> <p align="center"> <img border="1" src="fig-t00/tgb0004c.jpg" vspace="10" width="480" height="360" alt="「機能設計」・「仕様変更」を示す段落"></p> <hr> <H3><font color="#800000">議事録</font>の<font color="#800000">ポイント</font></H3> <p style="line-height: 150%; margin: 1 10"> 議事録はビジネス文書の一つですが，「主たる視点」は機能仕様書と同じ「私たち」です．機能仕様書では「（製品をともに開発する）私たち」であるのに対し，議事録では「<font color="#800000">（議事の決定にかかわった）私たち</font>」です．</p> <ul> <li> <p style="line-height: 150%; margin-top:0; margin-bottom:15"> <font color="#000080"> 社内会議，社外会議ともに議事録の作成者は会議の参加者であり，参加者を代表して議事録を作成するのが通例です．決定事項を述べる際は，「（参加者である私たちは）・・・を決定／承認した」あるいは「（参加者である私たちは）［ある理由]により，否決した／決定を繰り延べた」など「私たち」を「主たる視点」にした主文（要点）で明確に表します．</font></p> </li> <li> <p style="line-height: 150%; margin-top:0; margin-bottom:15"> <font color="#000080"> 一部の会議では，議決にかかわらない出席者（いわゆる，「事務局」）が議事録を作成する場合があります．この場合は「（議決権者により）第1号議案が承認された／されなかった」となります．</font></p> </li> </ul> <p style="line-height: 150%; margin: 1 10"> 議事録と機能仕様書ともに「私たち」を「主たる視点」にした主文を用いますが，両者では補足文の扱い方が異なります．機能仕様書では「製品の動作」を補足文にするのに対し，議事録では重要な発言を発言者名とともに議事録に残す場合があります．ただし，いかに重要な発言であったとしても「決定事項」が主文であり，「個々の発言」は補足文です．</p> <ul> <li> <p style="line-height: 150%; margin-top: 0; margin-bottom: 15"> <font color="#000080"> しばしば，発言を列挙しただけの議事録を見かけます．いわゆる「発言録」形式です．記録という目的で発言を残す場合もありますが，発言だけでは「決定事項」を表したことになりません．議事録は業務管理のエビデンス（証拠）となる文書です．決定事項があいまいでは会議に参加しなかった人には経過しか伝わりませんし，後に決定日・決定事項を検証する際に問題となるおそれがあります．</font></li> </ul> <p align="center"> <img border="1" src="fig-t00/tgb0004d.jpg" vspace="10" width="480" height="360" alt="「決定事項」が明確な議事録"></p> <HR><p> <a target="_parent" href="tgb-00-05f.htm"> <IMG SRC="../t1/nxt.gif" ALT="" ALIGN=BOTTOM width="37" height="37"></a> <B>次ページに進む</B><FONT COLOR="#008080"><B>（ボタンをクリックしてください）</B></FONT></p> <HR><DIV ALIGN=CENTER><A HREF="../../index.htm" TARGET="_parent"> <IMG SRC="../gif/modoru.gif" ALT="" ALIGN=BOTTOM width="180" height="50"></A></DIV> <HR> <DL> <DT> </DL> <HR> <p style="margin-top: 2; margin-bottom: 0; line-height:200%"> <IMG SRC="../gif/sec-teian-b.gif" ALT="実務別技術文書セミナー" ALIGN=BOTTOM width="540" height="26"></p> <TABLE cellspacing="0" cellpadding="0" width="913"> <TR> <TD VALIGN=TOP WIDTH=73> <DIV ALIGN=CENTER></DIV> </TD> <TD VALIGN=TOP BGCOLOR="#0080c0" WIDTH=5><BR> </TD> <TD VALIGN=TOP WIDTH=835> <DIV STYLE="line-height:1.5;margin-top:5px;margin-right:5px;margin-bottom:5px;margin-left:5px;"><FONT COLOR="#000080"><B>実務別技術文書セミナー</B></FONT>（出張開催形式）<SPAN STYLE="padding-top:5px;padding-right:5px;padding-bottom:5px;padding-left:5px;">「</SPAN><FONT COLOR="#800000"><B><SPAN STYLE="padding-top:5px;padding-right:5px;padding-bottom:5px;padding-left:5px;">わかりやすい技術文書の作成手法</SPAN></B></FONT>」は，業務で作成する機会の多い文書に応じた「<B>コース選択式</B>」です．各コースごとに必要な考え方・手法・ポイントを事例中心で解説します．</DIV> </TD> </TR><TR> <TD VALIGN=TOP WIDTH=73> <DIV STYLE="font-size:1px"></DIV> </TD> <TD VALIGN=TOP BGCOLOR="#0080c0" WIDTH=5> <DIV STYLE="font-size:2pt"></DIV> </TD> <TD VALIGN=TOP BGCOLOR="#0080c0" WIDTH=727> <DIV STYLE="font-size:2pt">.</DIV> </TD> </TR><TR> <TD VALIGN=TOP WIDTH=73> <DIV ALIGN=CENTER></DIV> </TD> <TD VALIGN=TOP BGCOLOR="#0080c0" WIDTH=5><BR> </TD> <TD VALIGN=TOP WIDTH=727> <DIV ALIGN=LEFT> <TABLE> <TR> <TD> <IMG SRC="../gif/tw6-sub6gb-ss.gif" ALT="わかりやすい技術文書の作成手法" ALIGN=BOTTOM width="400" height="75"></TD> <TD><BR> </TD> </TR> </TABLE> </DIV> </TD> </TR><TR> <TD VALIGN=TOP WIDTH=73> <DIV ALIGN=CENTER></DIV> </TD> <TD VALIGN=TOP BGCOLOR="#0080c0" WIDTH=5><BR> </TD> <TD VALIGN=TOP WIDTH=727> <DIV ALIGN=LEFT> <TABLE> <TR> <TD> <IMG SRC="../gif/tw6-sub6mnl-s4-f.gif" ALT="わかりやすい技術文書の作成手法＜報告文書＋機能仕様書編＞" ALIGN=MIDDLE VSPACE=10 width="400" height="36"></TD> <TD><A HREF="../t6f/gb-smnr-f.htm" TARGET="_parent"> <IMG SRC="../gif/lnk-htmlsg.gif" ALT="" ALIGN=BOTTOM width="95" height="36"></A></TD> <TD><A HREF="../t6f-pdf/gaiyo-gb01f.pdf" TARGET="_parent"> <IMG SRC="../gif/lnk-pdf2sg.gif" ALT="" ALIGN=BOTTOM width="210" height="36"></A></TD> </TR> </TABLE> </DIV> </TD> </TR><TR> <TD VALIGN=TOP WIDTH=73> <DIV ALIGN=CENTER></DIV> </TD> <TD VALIGN=TOP BGCOLOR="#0080c0" WIDTH=5><BR> </TD> <TD VALIGN=TOP WIDTH=727> <DIV ALIGN=LEFT> <TABLE> <TR> <TD> <IMG SRC="../gif/tw6-sub6mnl-s4-e.gif" ALT="わかりやすい技術文書の作成手法＜機能仕様書＋製品解説編＞" ALIGN=MIDDLE VSPACE=10 width="400" height="36"></TD> <TD><A HREF="../t6e/gb-smnr-t6e.htm" TARGET="_parent"> <IMG SRC="../gif/lnk-htmlsg.gif" ALT="" ALIGN=BOTTOM width="95" height="36"></A></TD> <TD><A HREF="../t6e-pdf/gaiyo-gb01e.pdf" TARGET="_parent"> <IMG SRC="../gif/lnk-pdf2sg.gif" ALT="" ALIGN=BOTTOM width="210" height="36"></A></TD> </TR> </TABLE> </DIV> </TD> </TR><TR> <TD VALIGN=TOP WIDTH=73> <DIV ALIGN=CENTER></DIV> </TD> <TD VALIGN=TOP BGCOLOR="#0080c0" WIDTH=5><BR> </TD> <TD VALIGN=TOP WIDTH=727> <DIV ALIGN=LEFT> <TABLE> <TR> <TD> <IMG SRC="../gif/tw6-sub6mnl-s4-g.gif" ALT="わかりやすい技術文書の作成手法＜機能仕様書＋技術メール編＞" ALIGN=MIDDLE VSPACE=10 width="400" height="36"></TD> <TD><A HREF="../t6g/gb-smnr-t6g.htm" TARGET="_parent"> <IMG SRC="../gif/lnk-htmlsg.gif" ALT="" ALIGN=BOTTOM width="95" height="36"></A></TD> <TD><A HREF="../t6g-pdf/gaiyo-gb01g.pdf" TARGET="_parent"> <IMG SRC="../gif/lnk-pdf2sg.gif" ALT="" ALIGN=BOTTOM width="210" height="36"></A></TD> </TR> </TABLE> </DIV> </TD> </TR><TR> <TD VALIGN=TOP WIDTH=73> <DIV STYLE="font-size:2pt"></DIV> </TD> <TD VALIGN=TOP BGCOLOR="#0080c0" WIDTH=5> <DIV STYLE="font-size:2pt"></DIV> </TD> <TD VALIGN=TOP BGCOLOR="#0080c0" WIDTH=727> <DIV STYLE="font-size:2pt">.</DIV> </TD> </TR><TR> <TD VALIGN=TOP WIDTH=73> <DIV STYLE="font-size:2pt"></DIV> </TD> <TD VALIGN=TOP BGCOLOR="#0080c0" WIDTH=5> <DIV STYLE="font-size:2pt"></DIV> </TD> <TD VALIGN=TOP BGCOLOR="#0080c0" WIDTH=727> <DIV STYLE="font-size:2pt">.</DIV> </TD> </TR> </TABLE> <DL> <DT>　</DL> <HR> <p> <B>テクニカルドキュメント・ビジネスドキュメントためのテクニカルライティングセミナー</B><BR> <B>わかりやすい技術文書・ビジネス文書の作成手法</B><BR> <B>技術文書の「書き方」－共通のポイントと各種文書への応用－<br> </B>Copyright:Takaaki-YAMANOUCHI/1995-2010<BR> 山之内孝明／(有)山之内総合研究所<BR> Takaaki Yamanouchi/ Yamanouchi Research Institute,Ltd.</p> </BODY>