マニュアル執筆が怖くなくなる、12の執筆ポイント
前回「『目次』の良し悪しが、すべてのマニュアルの良し悪しを決める」に引き続き、分かりやすいユーザーマニュアルの作成ポイントを説明します。前回は「構成」について説明しました。今回は「表現方法」についてです。 「操作マニュアル」「業務マニュアル」「障害対応マニュアル」 について、全部で12のポイントを解説します。 操作マニュアルを記述する 1．読み手に分かりやすい流れを考える ユーザーが操作マニュアルから知りたいことは「操作手順」と「操作の結果」です。 操作マニュアルでは、これらの情報を、「画面のイメージ」と「説明文」の組み合わせで表現します。 ＋ 操作の結果 操作の結果を表示する画面 処理内容や操作結果を説明する文章 ただし、一般的にシステムの操作は、次のような流れになります。 表示されている画面で操作を行う ↓ 結果の画面に遷移し、新たな画面が表示される≫ ↓ 表示されている画面で次の操作
お客様を知るためのマニュアル作成 - （旧姓）タケルンバ卿日記避難所
マニュアルを書くのはオススメ。プログラムの世界以外でもかなり有用だよ。 設計書よりもユーザーマニュアルを書こう！ - レベルエンター山本大のブログ 設計書に書かれた処理の手順なんてのを読んでも機能についてピンとこないが、 ユーザーマニュアルなら分かる。 なぜなら、分かるように書かなくてはならないからだ。 分かりやすくなくては、マニュアルの存在意義に関わる。 設計書よりもユーザーマニュアルを書こう！ - レベルエンター山本大のブログ こういう要素があるからこそ、書き手にとっていいトレーニングになるんですよ。取り組んでいることへの理解が進むし、ポイントの整理ができる。そして顧客の要望とか、需要なんかをつかみやすくなると思うんですよね。 読む人はプロではない 基本的にですよ、マニュアルというのは説明書なわけですよ。単純に考えてね。でだ、説明書が必要な人ってのは、使い方がわからないわけですな。知識
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
ちょっとした構成案を作れば、あなたのドキュメントはもっとわかりやすくなる！
