最も重要なドキュメントはユーザマニュアル

仕事の方が忙しすぎて１ヶ月ほど放置していたPilikaの開発を再開しました。
ドキュメント（Wiki）の整備をしていたところ、しばらく放置していた事が功を奏してか構成や機能的に煮詰められていない部分が露呈しています。そこで、ドキュメントの構成から見直すという作業を行いました。
そんな中で改めて強く思ったのですが、エンドユーザ向けマニュアルの質はソフトウェアの質と直結する、という事です。

ソフトウェアありきで考えた場合、それが完成していなくとも、設計や仕様に不備があるとマニュアルを書いていてキーボードが止まります。
これは、目的が曖昧であったりインターフェイスが不自然である為にユーザに何を伝えればよいかが不明瞭だからです。逆に言えば目的やインターフェイスが自然であれば、ユーザマニュアルにサクサク書けます。

これまで業務アプリを色々と作ってきましたが、本当にユーザマニュアルは軽視されていたと思います。ほとんどの場合、出来たアプリのスクリーンショットを撮り、Excelに貼り付け、目次とメニュー項目を書き出すという、「画面をみればいいじゃん」的なマニュアルが多数ありました。当然、そんなマニュアルなどは誰もみないわけですが・・・。

札幌Javaコミュニティの勉強会でもICONIXプロセスを勉強していましたが、特に「ユースケースがユーザマニュアルになる」ことが重要とされています。ユースケース（＝ユーザマニュアル）を先に作ることで、何を作るかと何を作ればよいかの契約を明確にする、という事がポイントです。

また、そのアプリケーション（プロジェクト）の特徴や目的を明確にすることも重要です。オープンソースのプロジェクトなどでは何を目標としているのかとなりますが、これは業務アプリケーションでは関係者の求めること（例えば、受注業務を自動的に処理することで処理を正確に早く２４時間体制とし販売拡大を狙う）が何であるかを常に念頭に置くことも重要です。エンドユーザ向けマニュアルでは、目的に対してどのようにアプリケーションを使えば回答となるかを記述することが重要で機能の羅列であってはならないのです。

ユーザマニュアル駆動開発ってのもありじゃないですかね。