マニュアルがあれば開発ドキュメントは要らない？

2月の特集「楽々デブドックを書こう！」の「正直使う？ガイドライン」の「第1回：開発者ガイドラインとはなんだ？」を掲載したところ、以下のような読者からの記事評価をいただいた。

「作成ドキュメントの情報量が多く管理がしづらい。ドキュメント作成工数に時間が取れない。顧客側の立場でもありますが、すべてのドキュメントに目を通すとは思えない。

それよりも完成後のマニュアル作成に力を入れれば、必然的に開発ドキュメントになるのではないかと最近は思っています。利用者の立場で書くマニュアル兼開発ドキュメント…な手法がほしい」

シンクイット編集部内では、このコメントのような手法が実現可能かどうか検討を行ったところ、「可能性はありそうだが、わからない。実際の企業ではどう考えているのかを知りたい」という意見で一致を見た。そこで急遽記事作成をスタートしたものが、本記事「ドキュメントvsマニュアル」だ。

取材する先として「マニュアル」に大きく力を入れているコンシューマ向けの製品群に着目した。今回取り上げた日本アイ・ビー・エム（以下、IBM）の「ホームページビルダー」は、付属マニュアルの完成度に定評があるだけでなく、インプレスジャパンが手がけたいわゆる「できるシリーズ」との同梱パッケージを提供している。

このホームページビルダーとできるシリーズを通じ、「マニュアルとはなにか」そして「開発ドキュメントの代替となり得るのか」の2点について述べていく。

同梱パッケージ誕生の裏側には

まず最初に話を伺ったのは、IBMのソフトウェア事業 WebSphere事業部 WebSphere事業開発 主任セールススペシャリストの加藤 泰子氏だ。

Think IT - ホームページビルダーのマニュアルはどのように作られているのでしょうか

加藤氏「製品マニュアルについては専門の部署が担当しています。ホームページビルダーはWindows向けのWebページ作成ソフトで、実際の開発を行う部署とソフトウェア内で参照するヘルプを作成する部署、そして製品に添付するマニュアルを担当する部署の3つが連携して作業を進めています」

Think IT - ずばり、マニュアルは開発ドキュメントの代わりになるものでしょうか

加藤氏「ホームページビルダーが3つの部署にわかれていることからも分かると思いますが、開発には開発の、マニュアルにはマニュアルの、といったようにそれぞれの役割があります。開発ドキュメントは『開発』に必要なものであり、ヘルプやマニュアルは出来上がったソフトウェアを『使う』ためのものです。

より細かく定義すると、ヘルプはそのソフトウェアが備えている機能を100%掲載しておく必要があるといえるでしょう。しかしマニュアルはユーザにとって重要度の高い情報を選りすぐった上でまとめておくものです。『操作の手順が記述されたもの＝マニュアル』といえるかもしれません」

Think IT - その「操作の手順が記述されている」という点ができるシリーズを同梱された理由でしょうか

加藤氏「その1つではあります。ホームページビルダーはコンシューマ向けのソフトという位置づけでもありますが、実は個人事業者の方をはじめ、ビジネスで利用されるユーザ数が多いのです。このような方たちにとってソフトウェアの使い方を覚える時間を割くよりも、まず目的の成果物を作ることこそが求められます。つまり、これらの人々の目的に沿うマニュアルとは『ある目的を達成するために最低限必要な機能がまとめられたもの』なのです

『このような機能をどのような仕様で実装しているか』というのは、ユーザ側がソフトウェアを使うという観点だけから見れば、必要のない情報かもしれません。しかし、マニュアルだけがあっても、ソフトウェア開発のドキュメントの代わりができるとはいえないのです」 次のページ