マニュアルの第1版を発行した後、その内容に追加や変更が必要な場合がしばしばあります。たとえば、「ソフトウェアのバージョンアップにより製品に新しい機能が追加された」あるいは「仕様の変更で新しい規格に対応できるようになった」などの場合には、それをマニュアルに反映させなければなりません。
印刷出版物に限らずディジタル文書でも「出版物」の内容の一部あ(るいは大部分を)変更する場合の方法には、「追補」と「改訂」があります。
「追補」とは、追加・変更すべき版の構成・内容はそのままとし、章の(あるいは全体の)最後に追加、変更内容を節(あるいは章)として補足する方法です。
また、「改訂」とは、追加・変更すべき版の構成・内容は、必要に応じて削除・追加・入替えもありうるとし、必要な箇所に追加・変更を行う方法です。
いずれの方法にも一長一短があります。追加・変更の内容に応じて方法を選択すべきです。追補と改訂を組み合わせてもよいと思います(例:第1版-第1版追補-第2版)。
「追補」も「改訂」も適切に行わないと読者(ユーザ)の誤解をまねくことになりかねません。大切なことは、「過去の版に対して“どこが”、“どのように”変わったのかを読者が容易に読み取れるようにする」ことです。
「追 補」による追加・変更 | 「改 訂」による追加・変更 |
|
方 法 | 旧版(追加・変更する前の版)をそのまま活用し、新しい内容をページ単位(通常2ページ以上)で章末(または本文末)に挿入する | 部分的な追加・変更や全体的な追加・変更にかかわらず、旧版を修正し発行する(印刷物の場合は「刷版」を作り直す) |
メリット |
読者にとって変更箇所がわかりやすい 既存のページ構成を使うため旧版のページ番号を移動させずにすむことがある(目次、索引の修正が少なくてすむ) |
変更(入れ替えや修正)に対応できる 改訂版を発行することで読者(ユーザ)に最新の情報を見やすい形で提供することができる |
デメリット |
旧版の内容をそのまま活かすことが前提のため内容の入替えにはあまり適していない 入替えの場合には序文や追補の冒頭で「旧版の*-*節○○を当追補○○と入れ替える」などと明示しておく必要がある |
読者(ユーザ)の手元にある旧版の破棄(あるいは回収)が必要となる どこが改訂されたか読者が判読できる工夫が必要となる 章の途中に1ページの追加をしただけでも、ページ番号の付け直し(それに伴う目次や索引のページ数の修正)が必要となる |
「正誤表」の扱い方
マニュアルに「正誤表」として1枚あるいは数ページの紙が挿入されているのを見たことがあるかもしれません。正誤表は「発行した版について、誤字誤植、名称、データの誤り、あるいは表記・表現の誤りを、その箇所と正誤を対比 して示す」補助的な印刷物です。
したがって、上述の「追補」あるいは「改訂」とはその目的が異なり、マニュアルへの内容の追加・変更は正誤表の扱いではありません。
<当コーナーの主旨とご閲覧にあたってのお願い>
当コーナーは、当社のテクニカルライティング研修コース(出張開催セミナー)の抜粋・プレビュー版です。
|
テクニカルライティングセミナー
マニュアル作成の進め方とわかりやすいマニュアルのポイント
Copyright:Takaaki-YAMANOUCHI/2002-2010
山之内孝明/有限会社 山之内総合研究所
Takaaki Yamanouchi/ Yamanouchi Research Institute,Ltd.
takaaki@yamanouchi-yri.com