『業務システムのためのユーザーマニュアル作成ガイド』――マニュアル作成の“間違った常識”と改善ガイド

SE関連本

» 2011/11/28

業務システムのためのユーザーマニュアル作成ガイド 黒田聡、雨宮拓、徳田直樹、高橋陽一 （著） 翔泳社 2009年1月 ISBN-10: 4798117145 ISBN-13: 978-4798117140 2604円（税込）

■たかがマニュアル、されどマニュアル

　長い開発が終わってようやく一息つけると思ったのもつかの間、「マニュアル作っておいて」という一言により、慌てて画面をキャプチャし始める。マニュアル担当になったものの、開発側の仕様決定遅れに引きずられてリリース前に徹夜して書き上げる……。こんな経験は皆さん、一度ならず、二度三度はあるだろう。

　なんだかんだとなくてはならないもの、それが「マニュアル」である。マニュアルに携わるエンジニアを救ってくれる（かもしれない）のが本書、『業務システムのためのユーザーマニュアル作成ガイド』だ。

■オーソドックスな章立て

　章立てを見ていこう。

• 第1章　マニュアル作成の「間違った常識」
• 第2章　マニュアルの企画はこう進める
• 第3章　マニュアルの文章はこう書く
• 第4章　マニュアルや仕様書をわかりやすくするビジュアル表現
• 第5章　マニュアルの内容・表現の校正はこう進める
• 第6章　マニュアルの保守管理はこうする
• 第7章　部品化と構造化で効率アップ

　第1章で「間違った常識」と読者の注意を喚起し、2章以降でマニュアルの作り方を順に説明していくという、オーソドックスなスタイルだ。「マニュアルの書き方を知りたい」読者にとっては一見、冗長にも見える。

■思わず読み込んだ「マニュアル作成の間違った常識」

　まずは、1章から紹介しよう。

• 1‐1 常識の誤り マニュアル作成は目次構成の検討から始める
• 1‐2 常識の誤り マニュアルは読者別に分冊にする

　「常識の誤り」とは、なかなか過激な見出しである。普段、当たり前にやっていることなのだが、本書によれば「誤り」らしい。こういうやや過激な見出しは往々にして中身が伴わないものが多いが、本書は読んで納得できた。例えば、1‐1の「マニュアル作成は目次構成の検討から始める」では、「典型的な目次先行検討法の例」として「XX設定・XX登録」など機能の羅列の悪い例が示されている。確かにやりがちである。この「誤り」に対する、本書の回答。

• 何を伝えたいのか明確にする
• 伝える内容を整理整頓する
• 見せ方、探させ方の設計が目次作成である

　なるほど納得。特に3番目は「目次作成とは何か？」という著者の定義が明確に主張されていて、分かりやすかった。

　続いて1‐2の読者別分冊、ここではよくある（でも良くはない）家電のマニュアルが例として挙げられている。

• 1冊目：「初めてお使いの方に」
• 2冊目：「取扱説明書応用編」
• 3冊目：「困ったときに」

　それぞれの問題点と改善例が示されている。読みながら一緒に考えてみるとよいだろう。

　本書は、他にもいろいろな「常識の誤り」を紹介している。

• 1‐3 常識の誤り 書き始める前に文章の組み立てを行う
• 1‐4 常識の誤り マニュアルでは操作と結果を分けて書く
• 1‐5 常識の誤り わかりやすいマニュアルを書ける人は、文章の上手な人
• 1‐6 常識の誤り 正しい日本語文法の知識は必須である
• 1‐7 常識の誤り マニュアルには索引は必須である

　ほとんどが「常識じゃなかったの!?」という内容だったので、思わず熟読してしまった。

　誤りの改善例として、「文章の組み立てのためには、マインドマップを使って書きたいことを視覚化する」というものがあったのだが、自分も同じ解決法を用いていたので、ほっとした。他にも「Wordの文章校正機能などを使って文法ミスを回避する」など、日ごろから行っておきたい例が紹介されている。

　1章はこの後の各章の導入部となっているので、飛ばさず読んでおきたい。

■マニュアルも企画が肝、実はシステム開発と同じなのかもしれない

　2章では「マニュアルの目次を仕上げるまで」――つまりマニュアルの企画段階について書いている。この章は内容が濃かった。

　業務フローを作成するところが出発点だ。しかも、導入前と導入後のフロー両方である。まるで業務分析をしているかのようだ。そこから「機能」「操作」へと落とし込んでいく。

　マニュアルらしいところは2-6の「期待に応えられないところを探し出す」だろう。「できると思っていることができないという情報もまた、必要な情報」というところは、利用側の立場になってみればよく分かる。実際にできると思って探し回るのは、経験上よくあることだ。

　2章は17節まであり、ボリュームが大きい。そのくらい、企画段階はマニュアルにおける“肝”なのだろう。

■マニュアル作成のプロによる作成に校正、保守の解説

　3章の「文章はこう書く」は、読者を絞り込むペルソナモデルからスタートし、漢字・ひらがなの使い分け、修飾語、接続詞、助詞、指示語、といった「書き方」についてのポイントを紹介している。文科系出身の人間は、息がつけるところだ。「に」と「へ」の区別などを再確認するのにちょうどよい。

　4章はビジュアル表現。ビジュアルと聞くとすぐにイラストを想像してしまうが、それだけではない。ビジュアルは特に、図解によるグルーピングなど、論理的な思考を試される。この4章でようやく、Wordの「段落書式の設定」といった、具体的なツールの使い方が出てくる。本書が、手法に重きを置いていないということがよく分かる。4章までを読めばひととおりのマニュアルが書けると思う。

　5章は校正について。PDF校正の利点についての説明は、マニュアル作成をやったことがある者としてよく分かる。

　6章では保守管理、7章では部品化・構造化について。通常のシステムマニュアルでここまで踏み込むのは容易ではない。ただしマニュアル管理の業務に携わったことがあれば、イメージがつきやすい内容だろう。

■まとめ。マニュアル作成側の地位向上はなるか？

　内容をまとめよう。1章の常識は、次章以降の導入部となっているため、読んでおく必要がある。2章以降は、作成の手順に沿った構成で分かりやすい。だからといって「さあ、作ってみよう」というチュートリアル形式の手段や方法ではなく、考え方が述べられているので応用が利く。

　マニュアル作成全般のフェイズだけでなく、メンテナンスのフェイズでも手元においておきたい本である。

　ただし、いくらマニュアルを工夫しても、出来の悪いシステムが良くなるわけではない。分かりにくいインターフェイスは分かりにくいままだ。

　だから、マニュアル作りが軽視されるのかもしれない。本来はシステム開発において開発側と両輪であるべきだし、マニュアル側から開発へ改善を求めるくらいが理想的なのだろう。