避けて通れないマニュアルのメンテナンス

啓学出版(今は存在していない)発行のマニュアルバイブル(絶版)という本があります。
この本から学んだことの一部をここに紹介していこうと思います。

マニュアルバイブルによるとメンテナンスのキモは人選。

自分史を書くということは、長い文章を作成することです。
うまい文章やわかりやすい文章は、文才に恵まれた人だけの特権だと思っていませんか?
もちろん文才に恵まれた人は、うまい文章やわかりやすい文章を書くことができます。
でも、特に文才がなくたって、十分にうまい文章やわかりやすい文章を書くことはできるんです。
ここでは、そのちょっとしたコツを1つずつ紹介していきます。

まったくそのとおりで。

とある製品がバージョンアップされる場合、マニュアル担当者はだいたいがゲンバージョンの製品を担当した人となるのだが、たまに交代することがある。
社内制作の場合は退職や部署異動が主な理由だが、そうでない場合もある。
そうでない場合は、前任者が同じ部署にいるわけだ。
そこでマニュアルが完成したあとのメンテナンスがされている場合とされていない場合があって、ひとえにその違いは担当者の個性に関わっているのだ。

ぼくもそんなにメンテナンスをする方ではないのだが、このぼくを上回るくらいダメダメ人間というものが存在して、「なんで」と呆然とする時間さえ惜しんで、現バージョンのマニュアルの資料整備から取りかかることもあるからだ。
とここまでは余談なのだ。

マニュアルのメンテナンスでやることは次の3つ。
・技術情報の誤記訂正
・仕様変更への対応
・記述の誤記訂正

ただし、これらは変更内容の洗い出しだけをすべきであって、訂正原本に赤字を入れることもない。
(赤字を入れるという人もいれば、原本データそのものまで修正してしまう人がいる)

なぜ、赤字を入れなくてもよいかというと次期発行時に編集方針が変わることがあるからだ。


チョイ上の自分史 わたし本 を作ろう!

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です