ユーザーマニュアル(取扱説明書)の実践
How to write user's manual for professional engineers; 工学コミュニケーションの基礎(TW05)
***
***
5.1 ユーザーマニュアル・取扱説明書の作成ポイ ント
5.1.1 情報を整理せずに書くと、必要な情報に アクセスしにくい
5.1.2 情報を整理すれば、必要な情報にアクセ スしやすい
5.2 企画・設計する
5.2.1 最初にユーザーマニュアルの「読み手」 と「目的」を分析する
5.2.2 全体の構成を設計する
5.3 ユースケースを想定する
5.3.1 読み手がしたい作業を探せるように目的 別に整理する(ユースケース、という用語の確認!)
(用語:機能仕様書:製品を開発する際の要件[必要
な項目]をまとめた文書)※機能仕様書とユーザーマニュアルは「違う!」が重要です
5.4 作業(タスク)を整理して説明する
5.4.1 料理の作り方をイメージして作業の手順 を書き出す
5.4.2 タスクを細かい作業に分けて整理する
5.5 手順の書き方
5.5.1 作業のステップに分けて書く
5.5.2 ステップの数は10個までにする
5.5.3 操作と結果をわけて書く
5.5.4 スクリーンショットを活用する
5.5.5 操作手順に見出しをつけて検索性を高め る
5.5.6 フォントを使い分けて可読性を高める
5.6 概要の書き方
5.6.1 作業の概要を必要な情報に絞って書く
5.6.2 概要のロジックの組み立てのポイント
5.6.3 後から見直し、練り上げる
5.7 参考情報の書き方
5.7.1 知っていると役立つ情報は参考情報とし てまとめる
5.7.2 参考情報の種類に合わせて見出しを付け
る
5.8 注意文の書き方
5.8.1 利用者の身体や財産に被害が生じたら、 損害賠償の責任が問われる
5.8.2 禁止事項や注意事項を明確にし、先に書
く
++++++++
ユーザーマニュアルをつくってみよう(教科書122 ページ)
取説とは、取り扱い説明書の略語。取説とユーザーマ ニュアルは同じでしょうか?
企画と設計をする
ユースケースを想定する
作業(タスク)を整理する。作業を説明する。
番号をつけて手順をわかりやすくする
スクリーンショットを活用する。ところでスクリーン ショットの意味わかりますか?
概要を書く。概要ってなに?
概要のロジックツリー(作業の全体と目的を伝える →1)どのような作業か、2)作業では何ができるのか、3)利用者のメリットはなにか)
参考情報の書き方。参考情報ってなに?参考情報の種 類は?(教科書 137ページ)
注意文の書き方。ところで注意文って何?
●実習:教科書122〜144ページを参考に、「マ スクの取り扱い方」の説明を作成してください。
【条件】
1 読み手
アルバイトで投票所の誘導係を担う大学生
2 目的
投票所における感染予防のため、マスクを正しく取 り扱うための説明書
3 ユースケース
あなたが手引きとなるマニュアルとして作成し、選 挙区内の投票所に配布します。各投票所では、「マスクの取り扱い方」に従って、投票当日にシフト勤務で参加するアルバイト大学生にマスクの正しい利用を徹 底するように指導と確認を行います。
留意:配布して読ませるだけではありません。
4 イラストを使用してもかまいませんが、あくまで も下記の留意点に注力してください。
1)情報を整理する
2)企画・設計をする
3)ユースケースを想定する
4)作業(タスク)を整理する
5)概要を書く。作業の全体と目的を伝える
6)手順をわかりやすく書く
7)注意文の書き方を学ぶ
【概要】
・
・
・
・
【注意文】
・
・
・
【手順】
・
・
・
※文字部分のみを作成し、イラスト部分はzoomで 実演いただく事で代用しても結構です。
TW05PR-200507.pdf TW05PR-200507.docx (パスワードはかかっていません。どなたでもご
自由に使えます)
●取り扱い説明書のライティングについて、アドバイスをしてください、をChat-GPTに質問しました(2023年4月17日)。GPT
1. 目的明確にする
取り扱い説明書を作成する前に、その文書の目的を明確にしましょう。読者に何を伝えたいのか、何を期待しているのかを把握し、それに基づいて文書作成の方針を決めましょう。
2. 読みやすくする
読みやすい文書にするためには、フォントや文字の大きさ、行間、段落の長さなどを考慮してレイアウトを決め、文章を分かりやすく整理しましょう。また、用語や表現は、読者が理解しやすいように、専門用語はできるだけ避け、一般的な言葉で書くように心がけましょう。
3. 実践的な内容を盛り込む
取り扱い説明書で伝える内容は、具体的で実践的なものであることが求められます。読者が実際に製品やサービスを使いながら解決すべき問題や、何を注意すべきなのかを詳しく説明しましょう。また、製品やサービスの良さや特徴をアピールすることも大切です。
4. 記号やイラストを使う
文字だけでなく、記号やイラストを使うことで、読者にとって理解しやすくすることができます。例えば、製品の機能や操作方法に関する図解や、注意すべきポイントを示すマークなどを使いましょう。
5. 全体の流れを理解しやすくする
取り扱い説明書は、順序や流れが重要です。全体の流れがわかりやすいよう、各セクションを明確に区分けし、分かりやすいタイトルや見出しをつけることで、読者にとって理解しやすい文書にしましょう。
6. 対象読者を意識する
文書を作成するときには、対象読者が誰なのかを意識することが重要です。読者のレベルや知識、使用目的などに合わせて、内容や表現を調節することで、読者にとって理解しやすくなります。
7. 校正を重視する
取り扱い説明書は、誤字や脱字があると、読者に信頼性を損なうことになります。仕上がりの前に何度も校正を重ね、誤字や脱字、間違いがないか確認しましょう。また、文書作成に慣れている人にチェックしてもらうこともオススメです。
++
リンク
文献
その他の情報