Top

hiroyuki.tank.support.site

簡単!マクロ講座

第49回〜マニュアルの重要性〜


 いままでほとんどふれていませんでしたが,忘れてはならない重要なことがあります。
 マニュアルです。ドキュメントとも呼ばれます。
 通常のシステム開発と呼ばれるものにはドキュメントを残すことが義務として課せられています。ドキュメントとはそのシステムの中身や使い方など作ったときのことが書いてあるものと思って間違いありません。システム開発ではドキュメントと呼びますが,普通はこう呼びませんからここではマニュアルとしておきます。

 マニュアルには大きく分けて,システムの概要,使用方法等を詳細に記録した利用者向けのマニュアルと,システムの構造,プログラムの構造等を詳細に記録した開発者向けのマニュアルの2種類があります。
 なぜ,マニュアルというものが必要なのでしょうか。
 例えば,誰かに頼まれたり,他の人に使ってもらえるかもと思って作ったものに使用方法などが何もなかったらもらった人はどうするでしょう?ベテランの人ならだいたいわかるかもしれませんが,パソコンに疎い人やましてや業務にも疎い人には???となるでしょう。なぜ必要かは説明するまでもなかったかもしれませんね。

 職場でのプロジェクトなどになると,「この事務改善をする必要性」といった,企画についての発起となる資料や,新しい様式による運用の開始の理由,様式の使用方法及び報告等の運用方法についてマニュアル化して配付する必要があります。

 なにかを作るということは,そのための説明資料=「マニュアル」をも作るということに他なりません。ただプログラムを書いて使えるものができたらそれで終わりではありません。
 現状業務を詳細に分析し,利用者の要求に沿った設計に従って,システムを構築し,その中でコンピュータを利用する業務を明確にして,システム化するという工程をまとめたマニュアル(ドキュメント)を作成するまでが必要なのです。
 マニュアルをきちんとしておくと,事務の統一化が図られますし,その次の作業が必要になったときも時間の短縮になります。
 マニュアルはつい億劫になったり忘れたりしますので注意してください。ものはできているのにその説明までくどくどするのはつい面倒になってしまうものですけどそこはもうひとふんばりです。

 マニュアルを作る際には,簡潔にわかりやすくということが必要です。あまり冗長になってもいけませんし,かといって簡潔すぎてわかりにくいということもだめです。
 どのくらいが適当かとういことはなかなか言葉では言い表せませんが,自分がしろうとさんだったらこれをみてわかるか?という疑問をもってみてみるとよいのではないでしょうか。
 私はマニュアルを作るときは「よくある質問」という項目を設け,全然質問されてはいないのですが,自分が自分に質問をしてその回答を書いています。自分が疑問になることは使う人も疑問になるだろうなと思うからです。
 もしよかったら参考にしてみて下さい。

 マニュアルづくりは通常の業務においても,「人になにかをわかるように説明する」といったことと通じています。マニュアルづくりがじょうずにできる人は説明上手だと思います。

| hiroyuki.tank.support.site.Top | このページのTop | マクロ講座目次 | 前回 | 次回 |