SHOEISHA iD

※旧SEメンバーシップ会員の方は、同じ登録情報(メールアドレス&パスワード)でログインいただけます

EnterpriseZine(エンタープライズジン)編集部では、情報システム担当、セキュリティ担当の方々向けに、EnterpriseZine Day、Security Online Day、DataTechという、3つのイベントを開催しております。それぞれ編集部独自の切り口で、業界トレンドや最新事例を網羅。最新の動向を知ることができる場として、好評を得ています。

直近開催のイベントはこちら!

Data Tech 2022

2022年12月8日(木)10:00~15:50

EnterpriseZine(エンタープライズジン)編集部では、情報システム担当、セキュリティ担当の方々向けの講座「EnterpriseZine Academy」や、すべてのITパーソンに向けた「新エバンジェリスト養成講座」などの講座を企画しています。EnterpriseZine編集部ならではの切り口・企画・講師セレクトで、明日を担うIT人材の育成をミッションに展開しております。

お申し込み受付中!

ドキュメント力を強化したい人のためのマニュアルライティング入門講座

ほんのすこし書き方に注意すれば、あなたのドキュメントはさらに分かりやすくなる!

第2回


マニュアルには、タイトル、概要、説明手順、補足情報といった要素が必要です。そして、各要素には、それぞれ分かりやすく書くコツがあります。今回は、マニュアルを構成する各要素の上手な書き方を紹介します。【バックナンバーもどうぞ!】

パーツ(部品)ごとに書き方があります

 マニュアルライティング講座の第1回目では、マニュアルを書き始める前に「文書の設計図である構成案」を作ることの大切さをお伝えしました。マニュアルのような構造化された文書を作るには、全体像を示す設計図が必須です。逆に言えば、設計図ができれば、わかりやすく伝える第一段階はクリアしたようなもの。

 今回は第2段階として、各ページの中のパーツ(部品)をわかりやすく書いていくためのポイントを説明していきましょう。突然ですが、お弁当の定番「幕の内弁当」をイメージしてみてください。幕の内弁当には、たいてい煮物、焼き物(魚など)、卵焼き、漬け物が、ご飯とともに詰められていますよね。これらがないと、幕の内弁当らしくなりません。

 ユーザーマニュアルにも、入れるべき要素があります。タイトル(見出し)、概要、説明手順、補足情報などです。日頃使っているケータイやデジカメの取説もソフトウェアのマニュアルも、そのような構成要素から成り立っているはずです。これらの構成要素であるパーツをきちんと揃えること。これが大切です。

 そして、各パーツには、わかりやすく書くためのコツがあります。そのコツを知れば、わかりやすさが向上します。どれも同じように書けば良いというのではないのが肝。素材ごとに、調理方法や味付けが違うからこそ、お弁当のおかずは美味しくなります。パーツごとのライティングの基本を押さえていきましょう。

次のページ
重要なことをざっくり伝える、それが概要の役割

この記事は参考になりましたか?

  • Facebook
  • Twitter
  • Pocket
  • note
ドキュメント力を強化したい人のためのマニュアルライティング入門講座連載記事一覧

もっと読む

この記事の著者

高橋 慈子(タカハシ シゲコ)

テクニカルライター。テクニカルコミュニケーションの専門会社 株式会社ハーティネス 代表取締役。マニュアル制作や改善に携わるほか、わかりやすく書く技術を盛りこんだ企業研修なども行っている。

※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です

この記事は参考になりましたか?

この記事をシェア

EnterpriseZine(エンタープライズジン)
https://enterprisezine.jp/article/detail/963 2009/01/28 14:45

Job Board

PR

おすすめ

アクセスランキング

アクセスランキング

イベント

EnterpriseZine(エンタープライズジン)編集部では、情報システム担当、セキュリティ担当の方々向けに、EnterpriseZine Day、Security Online Day、DataTechという、3つのイベントを開催しております。それぞれ編集部独自の切り口で、業界トレンドや最新事例を網羅。最新の動向を知ることができる場として、好評を得ています。

2022年12月8日(木)10:00~15:50

新規会員登録無料のご案内

  • ・全ての過去記事が閲覧できます
  • ・会員限定メルマガを受信できます

メールバックナンバー

アクセスランキング

アクセスランキング