マニュアル作成の進め方－機能仕様書をベースにする際のポイント－

<BODY BGCOLOR="#ffffff" LINK="#ffffff" VLINK="#ffffff"> <P> <img border="0" src="../gif/sec1.gif" alt="マニュアル作成のポイント" width="540" height="26"><br> <IMG SRC="../gif/tw2-1.gif" ALT="マニュアル作成の進め方" width="570" height="150"><hr><H1> <span style="font-weight: 400"><font color="#800000">機能仕様書をベースにする</font>際のポイント</span></H1> <blockquote> <blockquote> <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 style="margin:1 10; line-height: 150%; text-indent:15"> 製品のマニュアルを作成する際に機能仕様書をベースにする場合がしばしばあります。ただし、同じ製品が対象でも両者は目的が異なる文書です、ベースにする際はその違いを適切に把握してマニュアルのベースにする必要があります。</p> </td> </tr> </table> </blockquote> </blockquote> <hr> <h2><span style="font-weight: 400"><font color="#800000">見出し構成</font>の違い</span></h2> <p style="line-height: 150%; margin: 1 10; text-indent:15"> 見出し構成を比較すると、機能仕様書は<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"> 同様に機能仕様書では略語あるいは複合語を主体にした定型的な見出し名を用います。マニュアルに流用すると、読者には何を対象にしてどのような解説あるいは操作をするのか明確に伝わらないおそれがあります。</font></li> </ul> <p style="line-height: 150%; margin: 1 10; text-indent:15"> 機能仕様書をマニュアルのベースにする際は、機能仕様書の階層構成を調整するとともに見出し名も見直すのが適切です。</p> <p style="line-height: 150%; margin-top: 0; margin-bottom: 15" align="center"> <img border="1" src="t2-011a.jpg" vspace="10" hspace="5" width="432" height="324"><img border="1" src="t2-011b.jpg" vspace="10" hspace="5" width="432" height="324"><hr> <h2><span style="font-weight: 400"><font color="#800000">文体</font>の違い</span></h2> <p style="line-height: 150%; margin: 1 10; text-indent:15"> 機能仕様書は、<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"> 機能仕様書の「主たる視点」が「（ともに開発する）私たち」に対し、エンドユーザ向けの製品解説あるいはマニュアルでは「（ユーザである）あなた」です。</font></li> </ul> <p style="line-height: 150%; margin: 1 10; text-indent:15"> 機能仕様書をマニュアルのベースにする際は、文体をそのまま用いず「主たる視点」を変更して用いるのが適切です。</p> <p style="line-height: 150%; margin-top: 0; margin-bottom: 15" align="center"> <img border="1" src="t2-012.jpg" vspace="10" width="432" height="324"><HR> <p> <A HREF="t-2-1abs06f.htm" TARGET="_parent"> <IMG SRC="../gif/0000.gif" ALIGN=bottom width="37" height="37"></A> <B>次ページに進む</B><FONT COLOR="#008080"><B>（ボタンをクリックしてください）</B></FONT></p> <HR> <DIV ALIGN=CENTER> <p style="margin:1 10; line-height:150%; text-indent:15"> <img border="0" src="../gif/trp-000.gif" alt="山之内総合研究所の出張開催セミナー" width="300" height="20"></DIV> <DIV ALIGN=CENTER> <p style="margin:1 10; "> <a target="_parent" href="../t6-1st/gb-smnr-1st.htm"> <img border="0" src="../gif/trp-1st-a.gif" hspace="2" vspace="2" width="282" height="24"></a><a target="_parent" href="../t6/gb-smnr.htm"><img border="0" src="../gif/trp-gb-a.gif" hspace="2" vspace="2" width="282" height="24"></a></DIV> <DIV ALIGN=CENTER> <p style="margin:1 10; "> <a target="_parent" href="../t7/mn-smnr.htm"> <img border="0" src="../gif/trp-mn-a.gif" hspace="2" vspace="2" width="282" height="24"></a><a target="_parent" href="../t5a/tp-smnr.htm"><img border="0" src="../gif/trp-tp-a.gif" hspace="2" vspace="2" width="282" height="24"></a></DIV> <DIV ALIGN=CENTER> <p style="margin:1 10; "> <a TARGET="_parent" href="../t-smnr-faq/faq-101f.htm"> <IMG SRC="../gif/tsub-faq.gif" ALT="セミナー／コンサルティングFAQ" ALIGN=bottom BORDER=0 hspace="2" vspace="2" width="282" height="24"></a><a TARGET="_blank" href="../t-smnr-trf/smnr-trf02.pdf"><IMG SRC="../gif/tsub-trf.gif" ALT="セミナー基本料金［抜粋PDF版］" ALIGN=bottom BORDER=0 hspace="2" vspace="2" width="282" height="24"></a></DIV> <hr> <p align="center" style="margin-top: 0; margin-bottom: 0"><A HREF="../../index.htm" TARGET="_parent"> <IMG SRC="../gif/modoru.gif" ALT="" ALIGN=BOTTOM width="180" height="50"></A></p> <hr> <p> <B>テクニカルライティングセミナー</B><BR> <b>マニュアル作成の進め方とわかりやすいマニュアルのポイント</b><BR> Copyright:Takaaki-YAMANOUCHI/2002-2010<BR> 山之内孝明／有限会社　山之内総合研究所<BR> Takaaki Yamanouchi/ Yamanouchi Research Institute,Ltd.<BR> <IMG SRC="../gif/email.gif" ALT="" ALIGN=BOTTOM width="23" height="13"><FONT SIZE=4 COLOR="#000080">　</FONT><A HREF="mailto:takaaki@yamanouchi-yri.com"><FONT SIZE=4 COLOR="#000080">takaaki@yamanouchi-yri.com</FONT></A></p> </BODY>