- 0
- 0
- 12
質問
-
（ユーザー向け）マニュアル作成の基本
質問
私の場合は、基本、初心者レベルユーザの立場になって、
ユーザがどの場面（画面）で何をしたら良いのかを基準に
マニュアルを作成しています。
ユーザマニュアル作成の取りかかりは
画面キャプチャが基本です。
最初に画面キャプチャソフト（自分はWindowsのSnippingツールやSkitchなど)を
利用して画像ばかりを連続でキャプチャします。
その後、Excelやパワーポイント等で
操作手順どおりに画像を貼り付けた後、
どの画面（画像）で何をしたらとよいのかの「説明」と
「強調文字」＆「矢印図形」を駆使して
マニュアルを作成しています。
どのレベルのマニュアルを作成するのかは
ユーザの理解度によりますが、
だらだら説明文を書いたとしても
ユーザは隅々まで読んでくれない場合が多いため、
シンプルなマニュアルになるように気をつけて作成しています。
マニュアル作成の参考本などは
読んだこともありません（笑）
何回もユーザマニュアルを作成していけば
自然とコツが掴めてきますよ♪
何のマニュアルなのかによって答えが違ってきますが、何らかのシステムの操作マニュアルであるなら、幾つか注意点はあると思います。
・画面キャプチャを多用して直感的に分かりやすいようにする
・文章での説明文は避けること（誰も読まない）
・基本パターンに絞って、例外ケースなどは書かない（別途、詳細マニュアルとかQA集を用意する）
・後で変更することを考えて、管理情報（作成日、作成者、バージョン、変更履歴など）を付ける
・誰でも必要な時に参照できるようにする
こんな感じに細かく書いておいて何ですが、最も良い方法は、世の中の良いものをマネすることだと思ってます。
例えば、子供向けのゲームの操作マニュアルなんて良い教材だと思いまし、もう少しユーザーのレベルが高いなら、家電の説明書も良いと思います。
画面コピーの採取から作る場合とある程度形も素材もある時で違ってきますが、最終的に作る人のセンスとこだわり度で時間は変わってしまいますね。
個人的には画像はイメージがわけは解像度はあまり気にしないけど印刷した際に現実的かどうかコマンドプロンプトの画面を黒背景だと印刷すると読めないから白背景、黒文字にするとかは気を使います。あとファイルサイズがメールに載せれるサイズかも気にします
最近はマニュアルをメールで送る事も増えたので・・
細かい表現については各社が出してる日本語スタイルガイドを参考にするのがおすすめです。
http://www.jtca.org/publication/guide_jsg.html
https://www.microsoft.com/Language/ja-jp/StyleGuides.aspx
またまた、出遅れて大体既出かついつもどおり雑ですがコメントします。
私の現場ではマニュアルとなる場合
・機能マニュアル
・業務マニュアル
・運用マニュアル
に大別するイメージです
・機能マニュアルは、製造側の仕様書に近いイメージですべての機能に対して詳細に記載されており、まぁ実際の現場では使えないイメージですが、不具合かどうかの判定によくつかいます。
・業務マニュアルは、利用者の業務に即して画面遷移がどうとか、操作のコツとかやっちゃいけない操作などが書かれているイメージです。こちらだ一番利用させると思います。
・運用マニュアルは業務マニュアルをさらに実施する運用のみに特化して記載したもので、業務マニュアルから現場独自で手順が標準化されて作成されるイメージでね
この３つは製造→現場の距離感にあわせて必要だったり、機能マニュアルは製造側しか正直つくれない、業務マニュアルは本来は業務側の要件定義の結果できあがるイメージ、運用マニュアルは完全現場でのアレンジといったかたちで製造されるのが効率的ないめーじですね
もうすこし体系だってかけたらよかったのですが、まぁ雑にかくとこんな分類になるのではないでしょうか？
ここがごっちゃになると、ニーズにかなっていないので、つかえねーマニュアルだなとかセンスねーなーといわれます
はい、さんざんいわれました
sugi399さん
コメントありがとうございます。
作業を切り分けて、その作業ごとにやってしまうのですね。
説明文についてはなるべく具体的、かつ簡潔に書こうと思います。
一回一回自分で考えながら数をこなしていきたいと思います。
ハリコフさん
コメントありがとうございます。
自分はマニュアルを書いているうちに後からどんどん書きたい事が増えてしまっていたので、基本パターンに絞って、例外などについては別途用意するという点がとても参考になりました。
子供向けのゲーム操作マニュアルについては子供のころ読んだことがないので読んでみようと思います！
なんちゃってSEさん
コメントありがとうございます。
読み手の気持ちを考えるという意味で、印刷する際のことや、メールで送る場合のことなどに対する配慮も大切なのですね。とても勉強になりました。
のりおさん
コメントありがとうございます。
日本マニュアルコンテストというものがあることを初めて知りました。是非参考にさせていただきたいと思います！
しゅーめーさん
コメントありがとうございます。
さっそくご紹介いただいた本を買ってみたいと思います。まさにこういう本を探していました。
また、スタイルガイドについて教えていただきありがとうございます。日本語だけでなく、英語のマニュアルを作成する際にも、非常に強力なツールになると思います！
くるしぃさん
コメントありがとうございます。
体系立てて書いていただいたおかげで、それまで曖昧だったマニュアル作成という作業の基本的な部分について、とてもしっくり理解できました。ありがとうございます！
お役に立ちましたか？他にもたくさんの ノウハウが共有されています。
質問
こんばんは
どうもユーザーさん向けのマニュアル作りがうまく進まず、時間がかかってしまっている新人社員です。
皆さまはどのようにしてマニュアル作成の基本的なことを学ばれたのでしょうか。
マニュアル作成に関して参考になった本や、わかりやすく、読みやすいマニュアルにするために心掛けていること等があればシェアしていただきたいです。
宜しくお願い致します。