Manual Generator.でマニュアルを「管理する」

025_kannri

みなさんは誤って古いマニュアルを使い、作業してしまった経験はありますか? 私はあります。そう、あれはまだ私が23才の秋でした… と、この話はまた次回以降のエントリーに譲るとして。

情報が古くなったマニュアルは、それ自体が事故のもととなりえます。忙しくて更新できないまま忘れ去られてしまったマニュアル、古い内容だと知りながら気が乗らず改訂されなかったマニュアルなどなど、手違い・間違い・事故のもとはいたるところに転がっているのです。

そんな事故を防ぐために、Manual Generator.は常に最新のマニュアルだけを閲覧できるよう「公開」機能とバージョン管理機能を持ちあわせています。マニュアルはつくって終わりではなく、現場の声を反映し、常に新しいルールやノウハウによって進化すべきものです。Manual Generator.の持つ管理機能について、一つひとつ見ていきましょう。

マニュアルの「公開」機能

Manual Generator.には以下のアカウント種別があります。

  • 管理者:Manual Generator.のアカウント管理、マニュアルの編集、マニュアルの閲覧が可能
  • 編集者:マニュアルの編集、マニュアルの閲覧が可能
  • 閲覧者:マニュアルの閲覧が可能

マニュアルの編集者は作成途中のマニュアルを作業者(閲覧者)に見られることなく編集を行うことができます。いざ完成した段階になって「公開」機能を使うことにより、はじめて閲覧者にマニュアルを公開できるのです。つまり、管理者もしくは編集者がマニュアルを作成しただけでは閲覧できないようになっており、「公開」機能を使用してはじめてすべてのユーザーがマニュアルを閲覧できるようになります。

編集中と公開中

いったん「公開」されたマニュアルは、これ以降編集を加えることができなくなります。公開=出版と考えてみてください。出版された書籍は、これ以上を手を加えることができません。編集を行うには、新しい版(バージョン)として新たに出版しなおす必要があるのです。

マニュアルのバージョン管理機能

出版された書籍の奥付を見ると、「第○刷」という記載がどこかにあるかと思います。それがその書籍が「公開」された証であり、バージョン表記を兼ねています。基本的にそのバージョンへ変更を加えることはできず、なにかしら修正を行う場合は「第○刷」の○部分に1つ数字を加えたものを新バージョンとして印刷します。

Manual Generator.の場合は、「改訂」という機能によってバージョン管理を行います。公開されたマニュアルを「改訂」すると、中身がそっくりコピーされた新しいバージョンのマニュアルが作成されます。一つひとつのマニュアルには「改訂履歴」が内蔵されているため、「第○刷」にあたるバージョン情報を管理することができるのです。

バージョン情報だけではなく、承認者を記入する欄や、改訂内容の詳細が記入できる備考欄も設けています。「承認者 山田太郎」「第2版 P17の写真を新しい機械に変更」というように記載を残しておけば、厳格なルールに基づくマニュアルの運用も可能となります。

とはいえ新旧が一目で判断できなくては意味がありません。Manual Generator.は常に最新のマニュアルだけ「最新」アイコン表示がなされるため、そんな心配はご無用です。改訂元の古いマニュアルは「非公開」にしておけば、閲覧者から見ることができなくなります。古い情報は閲覧者から隠され、常に新しい情報だけが提供される  マニュアル運用の理想像がそこにあるのです。

最新アイコンとそうでないアイコン

ただの本棚を超えた、新しいマニュアル管理へ

マニュアルを本棚に並べておくだけでは、どれが最新か判断がつきません。Manual Generator.は、そんな従来のマニュアル管理を変革します。もちろん前々回で述べたように、Manual Generator.であればマニュアル編集のおっくうさもなんのその。気軽に手早く情報の更新ができるため、これまで感じていたようなマニュアル改訂作業のハードルも低くなること請け合いです。

これまで3回に分けて、Manual Generator.の機能を概観してきました。次回は、マニュアルを「つかう・見直す」という観点から、Manual Generator.に「いまはないけれど、将来的に追加したい機能」を取り上げたいと思います。お楽しみに。