わかりやすいマニュアル作成のための実践テクニカルライティングセミナー-第3部補足　追補と改訂-改訂履歴の表記方法

<BODY BGCOLOR="#ffffff" LINK="#ffffff" VLINK="#ffffff"> <P> <IMG SRC="../gif/sec3c.gif" ALT="" ALIGN=BOTTOM HSPACE=10 width="540" height="26"><BR> <IMG SRC="../gif/tw2-3s.gif" ALT="" ALIGN=BOTTOM width="570" height="150"><BR> <HR><BR></P><H1><DIV STYLE="line-height:1.5">改訂履歴の表記方法<BR></DIV></H1><P><DIV ALIGN=LEFT STYLE="line-height:0.5"><HR><BR></DIV></P><H3><FONT COLOR="#800000">改訂履歴の表記方法</FONT><BR></H3><UL> <DIV STYLE="line-height:1.5">「改訂履歴」とはその出版物が、初版の発行以降にどのような改訂をして現在にいたっているかを一覧にして示すものです。<BR></DIV> <DIV STYLE="line-height:0.5"><BR></DIV> <UL> <LI TYPE=disc><DIV STYLE="line-height:1.5"><FONT COLOR="#000080">これは、マニュアルを製作する側の管理上の必要性もありますが、読者に「いつどこがどのように変わったのか」を伝えるのに必要です。</FONT><BR></DIV> </UL><DIV STYLE="line-height:0.5"><BR></DIV> <DIV STYLE="line-height:1.5">改訂履歴は、表形式にして扉の次のページに置くのが一般的です。<BR></DIV> <DIV STYLE="line-height:0.5"><BR></DIV> <UL> <LI TYPE=disc><DIV STYLE="line-height:1.5"><FONT COLOR="#000080">扉の裏のページを使うか、ページをかえて新しく右ページに置く（これを「改丁する」といいます）とよいでしょう。。</FONT><BR></DIV> </UL><DIV STYLE="line-height:0.5"><BR> 改訂履歴の表には、「版数」、「発行日」、「改定概要」の見出しをつけ、改訂ごとの概要を簡潔に記述しておきます。<BR> <BR></DIV> <UL> <LI TYPE=disc><DIV STYLE="line-height:1.5"><FONT COLOR="#000080">改訂概要の項目には「第1版第2章に2-*節として『○○に関する注意』を追加」など「どこがどのように変わったのか」がわかるように必要最低限の情報を示しておきます。</FONT><BR></DIV> </UL></UL><P> <DIV ALIGN=CENTER STYLE="line-height:0.5"><IMG SRC="3-50.jpg" ALT="" ALIGN=BOTTOM WIDTH=480 HEIGHT=330 BORDER=1 VSPACE=10><BR></DIV> <DIV ALIGN=LEFT STYLE="line-height:0.5"><HR><BR></DIV></P><H3><FONT COLOR="#800000">とくに具体的な改訂内容を示す必要がある場合</FONT>-改訂序文を付ける-<BR></H3><UL> <DIV STYLE="line-height:1.5">改訂履歴の表だけでは、読者に改訂事項が具体的に伝わらないことがあります。このような場合には、序文の後に「<FONT COLOR="#008080"><B>改訂序文</B></FONT>」をつけてより具体的に改訂の理由や改訂内容を述べておく必要があります。<BR></DIV> <DIV STYLE="line-height:0.5"><BR></DIV> <UL> <LI TYPE=disc><DIV STYLE="line-height:1.5"><FONT COLOR="#000080">序文の裏のページを使うか、ページをかえて新しく右ページに「第2版の改訂にあたり」と題して改訂序文をまとめておくとよいでしょう。。</FONT><BR></DIV> </UL><DIV STYLE="line-height:0.5"><BR></DIV> <UL> <LI TYPE=disc><DIV STYLE="line-height:1.5"><FONT COLOR="#000080">改訂序文の入れ方としては、上記で述べるような旧版の序文を活かしその後に入れる方法と、旧版の序文を削除してしまう方法がありますがいずれでもかまいません。</FONT><BR></DIV> </UL></UL><P><HR><BR></P><H3><FONT COLOR="#800000">改訂履歴や改訂序文だけでは不十分</FONT>-改訂注、改訂索引を付ける-<BR></H3><UL> <DIV STYLE="line-height:1.5">先に述べたように、「改訂」では旧版のどこがどのように変更されたのかがわかににくくなってしまいます。「改訂履歴」や「改訂序文」はこれを補うものですがこれだけれは十分とはいえません。<BR></DIV> <DIV STYLE="line-height:0.5"><BR></DIV> <DIV STYLE="line-height:1.5">当該の変更箇所で「仕様の変更によりどこがどのように変わったのか」がわかりように「<FONT COLOR="#008080"><B>改訂注</B></FONT>」をいれておく必要があります。<BR></DIV> <DIV STYLE="line-height:0.5"><BR></DIV> <UL> <LI TYPE=disc><DIV STYLE="line-height:1.5"><FONT COLOR="#000080">「改訂注」は他の注記と区別できるような書式とし、当該の解説の後に「どのような理由でどのように変更されたか」を簡潔にまとめておくとよいでしょう。</FONT><BR></DIV> </UL><DIV STYLE="line-height:0.5"><BR></DIV> <UL> <LI TYPE=disc><DIV STYLE="line-height:1.5"><FONT COLOR="#000080">また「改訂注」には簡潔な見出しを付けておくとよいでしょう（例：改訂注「ソフトウェアVer.1.2に伴う○○の機能追加」</FONT><BR></DIV> </UL><DIV STYLE="line-height:0.5"><BR></DIV> <DIV STYLE="line-height:1.5">また、この「改訂注」の見出しを一覧化して「<FONT COLOR="#008080"><B>改訂索引</B></FONT>」として、巻末などに掲載しておけば読者にとってさらに便利になります。<BR></DIV> </UL><P> <HR><BR> <A HREF="t-2-3s99f.htm" TARGET="_parent"> <IMG SRC="../t1/nxt.gif" ALT="" ALIGN=BOTTOM width="37" height="37"></A> <B>次ページに進む</B><FONT COLOR="#008080"><B>（ボタンをクリックしてください）</B></FONT><BR> <HR><BR> <DIV ALIGN=CENTER><A HREF="../../index.htm" TARGET="_parent"> <IMG SRC="../gif/modoru.gif" ALT="" ALIGN=BOTTOM width="180" height="50"></A><BR></DIV> <HR><BR> Copyright:Takaaki-YAMANOUCHI/1995-2001<BR> 山之内孝明／(有)山之内総合研究所<BR> Takaaki Yamanouchi/ Yamanouchi Research Institute,Ltd.<BR> <BR> <BR></P></BODY>