開発ドキュメントとマニュアルの大きな違いは

Think IT - なぜマニュアルを作成することが、開発ドキュメントの代わりとはならないのでしょうか

加藤氏「先ほど申し上げましたが、『このような機能をどのような仕様で実装しているか』という情報は、ユーザ側には必要ありません。しかしそれがなければ開発側は開発を進めることができません。

では『それらの仕様もマニュアルに含めてしまえば』という考え方もあるかと思いますが、それは『ユーザに最低限必要な機能をまとめたもの』というマニュアルの定義から外れてしまい『良いマニュアル』ではなくなってしまうでしょう」

Think IT - 現在どのような流れでマニュアルを作成されているのでしょうか

加藤氏「ホームページビルダーの開発では、開発とヘルプ、マニュアルのそれぞれの部署で共通した「Lotus Notes」というグループウェアを活用し、情報を共有しています。開発の部分で仕様変更があった場合、速やかにヘルプやマニュアルに反映する必要があるからです。

発売直前まで、開発中のソフトウェアのテストが行われます。そこで不具合が発生すれば、その修正に合わせたマニュアルの変更も必要になります。しかし一方で「発売日」という点に着目すると、CD-ROMやDVD-ROMといったメディアよりもマニュアルのほうが締切日が早い、という問題があります。そこが『より良いマニュアル』を作る上での大きな課題だと思います」

Think IT - 最後に、マニュアルに期待することはなんでしょうか

マニュアルには、やはり最低限必要な機能が理解しやすく、また実際の操作について分かりやすく記述されていることが重要だと思います。分かりにくい操作は画面があったほうが理解しやすく、また間違いも少なくなります。そういった面に配慮したマニュアル作りを続けていきたいですね。

同梱版できるシリーズ担当者の声は

さて、一方でホームページビルダーに同梱された「できるシリーズ」を手がけているインプレスジャパンの側は、今回のテーマである「マニュアルと開発ドキュメントの関係」についてどのように考えているのだろうか。

インプレスジャパンで「できるシリーズの同梱版」を担当する部署に話を伺った。

Think IT - まず、できるシリーズとはなにかを一言でいうと、なんでしょうか

担当「同梱版のできるシリーズがどこに位置づけられるかというと、ソフトウェア製品には仕様書があり、それを基に成果物ができます。ここでいう成果物はソフトウェアそのものですので、それの解説をする、成果物からユーザ向けに作られるできるシリーズは二次制作物なんですね」

Think IT - 今回のホームページビルダーとできるシリーズのような製品との同梱版は、いつから制作作業がスタートするのでしょうか

担当「ソフトウェアにもよりますが、ソフトウェアの発売日に合わせなければならない場合には、完成前の段階から開発側と密接に連携を取りながら作業を進めています。もちろん必要であれば、事前に仕様書を読んだり、α版に触れることもありますね。

ただし、できるシリーズの場合はいわゆるマニュアルではなく、よりユーザ視点に立った解説本です。このため実際のソフトウェアを触って、ユーザ視点で『これはこう表現したらいいだろう』と考えつつ、使い方を解説しています。

全機能を解説しているわけではなく、実際にユーザに必要な機能を分かりやすく説明している本なので、システムの全機能を解説するようなマニュアルとは違う位置づけのものになります」

Think IT - 開発ドキュメントとマニュアルは違うものなのでしょうか、それとも同じものなのでしょうか

担当「それは明確に違うものだと考えています。仕様書がなくてマニュアルだけがあった場合、『それを参考にしてソフトウェアを開発しろ』といわれても、特にできるシリーズの場合は無理ですね。仕様書はやはり開発に不可欠なドキュメントだと考えています」 次のページ