マニュアル作成業務

-良いマニュアルとは-

このページでは、当事務所の考えるマニュアルの目的およびマニュアルの要件について説明します。

私達は「マニュアルは、パッケージに収められたサポートである」と考えます。

マニュアルの目的はお客様に快適に商品をお使いいただくことであり、商品を購入されたお客様へのメッセージでもあります。

しかし、これだけでは漠然としているので、どういうマニュアルが良いかを、それぞれお客様およびメーカー様の視点から記します。
実際には、想定されるユーザー層、ソフトウェアの性格やメーカーのサポートの方針などによって細かい部分は変化しますが、基本的な要件としては以下のように考えています。

お客様の視点

  • やりたいこと(作業の目的)に簡単にアクセスできる

  • 必要充分な情報が掲載されている

メーカー様の視点

  • 製品の評価を高めるとはいかなくとも、少なくとも評価を下げない

  • 必要充分な説明があり、一般的な操作にはサポートが必要ない

  • 連絡先、商標等が正しい(必須)

  • ある程度特殊な場合を含む、全ての操作に説明がある

これら以外にも、コスト、携帯性、デザインなどのポイントはありますが、ここではライティングの範囲に絞ります。

構造的手法

弊社では、こういったことを構造的な手法によって実現しております。

構造化といっても難しいことではありません。「目的」→「概要」→「操作」→「付随的説明」の順に詳細化していくということです。
いくつかの異なった内容の設定を一画面で行うプログラムを想定してみます(こういったプログラムはユーザーインターフェイスの設計に問題があるといえます)。
この説明を画面の構造に従って行うと非常に難解な説明になります。
むしろ、目的別に項目を分けて同じ画面を別々に説明するほうがよいと考えています。

このスタイルを目次の設計から、各項目の原稿にまで反映させることにより、見通しがよく、わかりやすいマニュアル原稿を作成します。

以下、どのように実現するかをそれらを実際の作業に即して説明します。

NEXT→