取説屋ブログ なんでも取扱説明書作ります

 
取説屋:石井ライティング事務所のテクニカルライター兼代表の石井宏治のブログです。
【わかりやすいマニュアルの作り方】第8回 アウトラインモード・構造はどうする?
前回は目次構成案を作るソフトについてワープロ、表計算、アウトラインの3つについてそれぞれメリットとデメリットをあげました。
実際には、使用するシーンによって使い分けるというおもしろくもない結論ですが、今回は私が主に使っているアウトラインモードについて説明します。
前回のメリットデメリットは以下の通りです。

●ワードプロセッサで「アウトライン形式」として作成
◆メリット
・作成が容易。
・順序の入れ替えや、前後・親子関係の変更などが容易。
・できた目次からそのまま原稿作成にかかれる
◆デメリット:
・目次としてはそのままでは見栄えが悪いため、見かけを整える作業が必要。

アウトラインモードは「論理的に構成された長文」を書くのに便利な機能です。というよりも、この用途以外では使えないと言って良いでしょう。
同じ長文でも、(たぶん)小説を書くのには向いていません。
専用のソフトに「アウトラインプロセッサ」がありますが、これはその一部の機能を取り出したものともいえます。
アウトラインモードを使う場合は文章を書くというよりも、「文章を設計する」と言った方が実体に即しているといえそうです。
さて、ここで第6回ともリンクしていきます。
全体の構造の設計です。

各レベルごとに見出しを入力していきます。
1レベルは概念的なくくりとなります、ページ数にもよりますが「章」に相当します。たとえば、一般的な機器の場合はこんな感じとなります。

前説(目次や挨拶など)
導入(設置や使用前の準備)
使い方
設定
付録(用語集、索引、困ったときは、商標、問い合わせ先など)

この中に、2レベル、3レベルと設計していきます。

これらの見出しは後で変更することも容易ですから、最初はとりあえず気にせず全体の構造を作っていきます。
一般的に、構造で読むことができるのは3レベルまでです。
それよりもレベルが深くなりすぎるようなら、上のレベルから構造全体を見直す(分冊を検討する、章の上に編を作って構造を分離する)か、不必要に詳細化した構造を作成していないか再検討する必要があります。
また、機能や作業の項目が多く、2レベル(項)や3レベル(目)の項目が膨大になった場合は通常の形式のマニュアルではなく、リファレンス形式(手引書や辞書のような形式)を採用して、その部分を分離することも考える必要があるかもしれません。

続きます。
【わかりやすいマニュアルの作り方】第7回 どうやって書いていこう?(ワープロ)
第7回です。
マニュアルの目次構成の作り方について説明しています。

さて。
ここで一旦話の方向を変えてみます。
目次構成案を作成するときのワープロの使い方についてです。
目次構成員を作成するときのツールとしては、いくつかのやり方があります。
1つ目は、普通にワードプロセッサ(Wordなど)を使用して原稿をテキストとして作成していきます。
2つ目は、表計算ソフト(Excelなど)を使用して原稿を作成します。データがセルに入るため、順序を入れ替えたりするデータとしての取扱はよくなります。
3つめは、やはりワードプロセッサを使用して原稿を作成しますが、いわゆる原稿形式で作成するのではなく「アウトライン形式」で作成します。
それぞれ、メリット・デメリットがありますが、私の場合は特に注文がない限り、3つ目のアウトライン形式で作成する場合がほとんどです。

それぞれについて説明します。

●ワードプロセッサで通常の原稿として作成
◆メリット
・作成が容易。
・見栄えの良い目次らしい原稿を作れます。
◆デメリット:
・順序の入れ替えや、前後・親子関係の変更などは困難。
 手作業でそれぞれを変更する必要があります。
・テキストデータなので、目次として使う以外に転用できる。

●表計算ソフトを使用
◆メリット
・作成はまぁ容易。
・順序の入れ替えは容易
・表計算は構造を持っていないので前後・親子関係の変更などは困難。
・見栄えを良くするには手間がかかる
◆デメリット:
・表計算のデータは転用がやりにくい。
・目次から新たにもう1度原稿を起こし直す必要がある

●ワードプロセッサで「アウトライン形式」として作成
◆メリット
・作成が容易。
・順序の入れ替えや、前後・親子関係の変更などが容易。
・できた目次からそのまま原稿作成にかかれる
◆デメリット:
・目次としてはそのままでは見栄えが悪いため、見かけを整える作業が必要。

続きます。
- : comments (0) : trackback (x)
【わかりやすいマニュアルの作り方】第6回 さて、全体の見通しはどうしよう?
第6回です。
前回までは、最初の取材の内容について書いてきました。前回まで、いったん取材を終了したとします。
もちろん、この取材・打ち合わせの中で、予算をはじめ、版型・ページ数などといったことも大まかに打ち合わせています。
ここまでで、外形はおおよそ定まっているわけです。

これから、内容を検討して、取扱説明書の内容を「目次構成案」という形にしていくわけです。
目次構成といっても、何もないところから作るわけではありません。
一般的に、目次、前説、準備作業、作業の開始と終了、主な作業、詳細な設定、付録(用語集など)、索引などから、作成するマニュアルに必要なものだけを抽出して組み合わせます。
機械や装置の場合は、主に準備作業(組み立て・設置など)が主な部分となります。
パソコンのソフトウェアなどの場合は、詳細な設定や用語集などが主な部分となります。業務マニュアルの場合は作業の開始と終了、主な作業、用語集などが主な部分となります。
このように、目的によって必要な内容が異なります。これらまのバランスを考えながら、必要な内容を全部網羅するように構成案を作成します。
前説の後に、製品安全(PL法関連)に関する記述が必要な場合がありますが、この部分については、主に法務部において作成するものなので、ページをあけておくだけにする場合が多いです。
【わかりやすいマニュアルの作り方】第5回  その製品はどういうものですか?
前回、製品については下調べをしておくのが当然だということを書きました。
それでは取材では何を聞くのでしょうか。
取材で聞くことは「その製品で何をしたかったか」です。
エンジニアさんの思いや夢、実現したかった機能や、これまで不便だったのを改良した点、誰に使ってほしいと考えているかといったことを伺います。
なぜこのようなことを聞くかというと、製品開発の方向を確認するためです。
いくらこちらが良いと思ったマニュアルを制作しても、製品開発の方向とずれていては望ましいマニュアルとはいえません。
業務マニュアルについてはより一層強く言えることです。
また営業の人にもどのような人に売りたいかといった話を伺うこともあります。
また、過去のバージョンの製品がある場合などは、特にユーザーサポート担当の人にお話しを伺うととても役にたちます。
営業やユーザーサポートの人は、製品を使っているユーザーに直接話をうかがっている人たちです。この人たちが困っている点や、便利に思っている点を知ることで、良いマニュアルを作るための方向性をしっかりと定めることができるのです。
内容としては多少雑談に近くなる場合もあります。
しかし、この取材が、全体の構想を決めるときに最も重要な取材となるのです。
【わかりやすいマニュアルの作り方】第4回  何のマニュアルを作るのですか?」
ここまでは、最初にマニュアルを依頼されたとき「だれが・どこで使うか」を最初に訪ねるということを書いてきました。
それでは、その次の取材内容は何でしょうか。

ここまで読んでいらっしゃった方はすでにお気づきとは思いますが、普通ならば最初にされそうな質問「何のマニュアルを作るのですか?」です。
つまり、対象となる製品についての取材です。

種明かしをすると、取材にお伺いする前にはあらかじめ電話などで事前に概要の打ち合わせを行います。この時点で製品自体はわかりますから、質問内容は「何のマニュアルを作るのですか?」とは微妙に異なるのです。

電話打ち合わせの後、その対象のジャンルの製品や、使われる場所、特徴などをウェブや資料を読み込んで調べておくことは前提です、
どんなに時間がなくても、最低限、依頼された製品のシリーズ製品など、関連製品についての基礎知識だけは持っていないとお話になりません。
これは、業務マニュアルについても同じことで、全く知らない業界の業務マニュアルを依頼されても、わからないことだらけで、迷うことの方が多かったりすると、打ち合わせにならないからです。事前の準備は大変に重要です。
もっとも細かい部分になると、「そんなことどうやって調べたらいいのだろう」といって考え込んでしまう場合も多々ありますが。

さて、いよいよマニュアルの対象となるもの(あるいはこと)についての取材を開始します。
事前調査の話が予想以上に長くなってしまったので、製品の取材についての話は次回に続きます、
Aug.2008
S M T W T F S
          1 2
3 4 5 6 7 8 9
10 11 12 13 14 15 16
17 18 19 20 21 22 23
24 25 26 27 28 29 30
31            
横 300 pixel 縦 192 pixelです。(ブログの初期設定で設定してください)
横 423 pixelを超えると、表示がくずれる場合があります。