コンテンツにスキップ

【わかりやすいマニュアルの作り方】第18回 取扱説明書用の5W1Hとは?

さて、18回です。

とは言っても気分的には19回ですが…

実はこのブログ、主にW-Zero3 esを使って書いているのですが、クラッシュに伴い、バックアップからリカバリしたらメールのデータも消えてしまいました。
前回までの分はすでに送信して保存してあったため、問題なく回収できましたが未送信だった今回分の原稿は失われてしまったのでした。
バックアップは大切です。
ちなみに、筆者は週に1度バックアップをとっています。

さて。
前回は以下のように書きました。

仕様書には普通「目的」と「使用する状況」が書かれています。
ここから、チェックシートを作っていきます。
さて、その「チェックシート」の内容ですが、別に難しいことはありません。
5W1Hと言う言葉は聞いたことがあると思いますが、要は仕様書をそれに当てはめてリライトしてやるのです。

取扱説明書用の5W1H

取扱説明書用の5W1Hです。これに当てはめて仕様書をリライトしていくわけです。

5W1H

Who(誰が):その機能を使うのは誰か。一般的なユーザーか、エンジニアか、管理者などの権限を持つ人か。

  • What(何を):操作される対象は何か
  • When(いつ):操作はどのような状況で行うのか。ユーザーが操作したときか、起動時・終了時・エラー発生時などに自動的に起動されて行う操作なのか。
  • Where(どこで):機能の及ぶ範囲はどこまでか。空間的なものと時間的なものを含みます。
  • Why(どうして):機能の目的です。機能が何のためにあるかです。
  • How(どのように):機能の働き方です。一般的に、これが省略されていることはまずありません。

仕様書にはこれらの情報がすべて盛り込まれていることはまずありません。なぜならば、仕様書はエンジニア向けの資料であり、仕様書を書くときはたいがい時間的な制約があります。そして、「誰が」「どこで」などはデフォルト値が暗黙的に推定され、記載されない場合がほとんどだからです。
優秀な仕様書の場合は「なぜ」が書いてあり、使用の理解に役立つ場合があります。こういう仕様書はほんとうにありがたいものです。

続きます。

コメントを残す

メールアドレスが公開されることはありません。 が付いている欄は必須項目です