| 【わかりやすいマニュアルの作り方】第20回 目次構成案はどういう構造？ |
18/Nov.2008 [Tue] 10:14 |
さて、第20回です。
ようやく制作にかかるわけです。
実際の業務でしたら、あまりの遅さにクレームが付く進行ですね。
さて。
前回は以下のように終わりました。
-----------------
さて、仕様書を読み終わったことですし、次回からそろそろ全体の構成案と目次構成案の作成に進みましょうか。
-----------------
さてその「目次構成案」ですがどういう構造になっているでしょうか。
マニュアルにはおおよそ定型があります。
まず「お買い上げありがとうございます、この製品は…」といった前置き、続いてP/L法関連の定型文、それから目次、本文、そして最後に（望めるならば）索引、奥付の順です。一部は前後しても。まずこの大きなくくりは変化しません。
ということは、逆にここまでは固定してしまって、パターンやテンプレートとしてしまった方が得策です。P/L法関連の定型文などは、マニュアル部門ではほとんど触れず、法務部門のチェックを受けた後は変更しない方が良い場合が多いほどです。
ということは、マニュアルの目次構成を考えると言う作業は、中身のことを考えるということをいいます、という実に当たり前の結論になったところで次週に続きます。
|
| 今週はサイトリニューアルのためお休みします |
11/Nov.2008 [Tue] 12:30 |
タイトルの通り、今週はサイトリニューアルのため、「わかりやすいマニュアルの作り方」をお休みさせていただきます。
楽しみにされている読者の方（いるのでしょうか？）には申し訳ありません。
- : comments (0) : trackback (x) |
| トップページを更新しました |
10/Nov.2008 [Mon] 18:36 |
タイトルの通り、トップページを更新しました。
いままでの２行表示から３行表示に、サービス内容は下に移動してすこしすっきりさせました。
テーブルのサイズの修正に少し手間取りましたが、いままでよりはすっきりしたのではないかと思います。
- : comments (0) : trackback (x) |
| 【わかりやすいマニュアルの作り方】第19回 仕様書をクリアに読める？ |
05/Nov.2008 [Wed] 9:52 |
ひとまず佳境の19回です。
>5W1Hと言う言葉は聞いたことがあると思いますが、要は仕様書をそれに当てはめてリライトしてやるのです。
>ーーーーーーーーーーーーーーーー
>取扱説明書用の５Ｗ１Ｈです。
というところまで説明しました。
実際にやってみると、かならずしも全部を補う必要があるわけではないことはわかると思います。どこを省いて良いかは経験で知ることになりますが。
そして、これを終えると、わかりにくかった仕様書がクリアに読めることに気が付くと思います。
優秀なテクニカルライターならば、この手順を全部とばして、いきなり目次構成の作成まで進むことができます。
このあたりが経験であり、私がこういうノウハウを公開してもすぐには追いつかれない、飯を食っていけるゆえんでもあるわけです。
さて、仕様書を読み終わったことですし、次回からそろそろ全体の構成案と目次構成案の作成に進みましょうか。
|
| 【わかりやすいマニュアルの作り方】第18回 取扱説明書用の５Ｗ１Ｈとは？ |
29/Oct.2008 [Wed] 9:07 |
さて、18回です。
とは言っても気分的には19回ですが…
実はこのブログ、主にW-Zero3 esを使って書いているのですが、クラッシュに伴い、バックアップからリカバリしたらメールのデータも消えてしまいました。
前回までの分はすでに送信して保存してあったため、問題なく回収できましたが未送信だった今回分の原稿は失われてしまったのでした。
バックアップは大切です。
ちなみに、筆者は週に1度バックアップをとっています。
さて。
前回は以下のように書きました。
ーーーーーーーーーーーーーーーー
仕様書には普通「目的」と「使用する状況」が書かれています。
ここから、チェックシートを作っていきます。
さて、その「チェックシート」の内容ですが、別に難しいことはありません。
5W1Hと言う言葉は聞いたことがあると思いますが、要は仕様書をそれに当てはめてリライトしてやるのです。
ーーーーーーーーーーーーーーーー
取扱説明書用の５Ｗ１Ｈです。
５Ｗ１Ｈ
Who（誰が）：その機能を使うのは誰か。一般的なユーザーか、エンジニアか、管理者などの権限を持つ人か。
What（何を）：操作される対象は何か>When（いつ）：操作はどのような状況で行うのか。ユーザーが操作したときか、起動時・終了時・エラー発生時などに自動的に起動されて行う操作なのか。
Where（どこで）：機能の及ぶ範囲はどこまでか。空間的なものと時間的なものを含みます。
Why（どうして）：機能の目的です。機能が何のためにあるかです。
How（どのように）：機能の働き方です。一般的に、これが省略されていることはまずありません。
仕様書にはこれらの情報がすべて盛り込まれていることはまずありません。なぜならば、仕様書はエンジニア向けの資料であり、仕様書を書くときはたいがい時間的な制約があります。そして、「誰が」「どこで」などはデフォルト値が暗黙的に推定され、記載されない場合がほとんどだからです。
優秀な仕様書の場合は「なぜ」が書いてあり、使用の理解に役立つ場合があります。こういう仕様書はほんとうにありがたいものです。
続きます。
|
