Column

マニュアル

2023-01-17

【マニュアル制作コラム:第6回】トピックライティングの勧め

製品マニュアルは、製品の扱い方や操作方法などをユーザーへ的確に説明するものですが、同時にユーザーへ禁止事項やエラー発生時の解決方法を伝える重要な役割があります。 時には、命に関わるリスクを説明する場合もあり、分かりやすく的確に伝わるものでなければなりません。 しかし、ページ数が膨大になる製品マニュアルの場合、分かりやすく的確に伝えることは容易ではありません。今回は、分かりやすく的確に伝えるマニュアルへの近道として、トピックライティングをご紹介します。

【マニュアル制作コラム:第6回】トピックライティングの勧め

1.トピックライティングとは

トピックライティングは、トピック指向ライティングと呼ばれます。最小単位のまとまった情報を1つの「トピック」として、ライティングをする手法です。

1つの「トピック」にタスク(手順)を書き、複数のトピックを組み合わせることによってマニュアルを形成します。1つの「トピック」=1つのタスクという構成になっているため、そのトピックだけ読めばやるべきことを探して完結することができます。

2.これまでと何が違うのか? 従来からの違いとメリット

冊子(ブック)の形をした紙マニュアルを、ペラペラとめくるシーンを思い浮かべてください。

従来のマニュアルは、多くの場合ブック指向ライティングという方法で構成されています。ブック指向ライティングは、前から順にページを読み進めることを前提としているため、全体を読まないと理解できないというデメリットがあります。

一方トピックライティングは、複数のページをまたがず、一つのトピックで情報を伝えることができるため、ブック指向ライティングより素早く情報を伝えられます。

最近は、紙媒体での提供は減少しており、WEB形式が主体になっていることから、ユーザーは知りたい情報を検索して探します。トピックの形に提供情報を細分化することにより、やりたいことへ素早くユーザーがたどり着けるため、トピックライティングの方法を用いたマニュアルの見直しが求められています。

3.トピックライティングへのリライト例

では、実際にどのような変化が得られるのでしょうか。

従来、

  • 「初期設定の仕方」

というタイトルになっていたマニュアルがあるとします。

このような場合、タイトルの中身を読まなければ、そこにやりたいことが書かれているか判断できません。

これをトピック指向ライティングで構成を見直すと、

  • 「電源を入れる」
  • 「インターネットに接続する」
  • 「パスワードを設定する」

など、それぞれの初期設定時の具体的なタスクにタイトルが変わります。

1タスク=1トピックなので、それぞれが独立したトピックになり、ユーザーは自分がやりたいことを瞬時に探せるようになるのです。

4.トピックライティングの進め方

これまで紹介した通り、トピックライティングはWEB上での提供により、さらなるメリットを発揮します。そのため、フレキシブルなアウトプットに対応する「XML」や「DITA」での制作をお勧めします。

制作ツールを変えることと合わせて、全体を見直し、構成を考え、既存のブック指向ライティングのマニュアルをトピックライティングに置き換える必要もあります。

最後に

クイックスでは、トピックライティングに適したツールとして「i-Share」を提供しています。シンプルで分かりやすく、簡単に始めることができるマニュアル制作プラットフォームです。

また、マニュアル制作代行サービスも行っております。古いマニュアルの載せ替え、新しいマニュアルの作成など、経験豊かな担当者が対応いたします。

お気軽にお問い合わせください。

マニュアルに関するお問い合わせはこちら

Events / Seminars

マーケティング

オンデマンドセミナー

オンデマンドセミナー

【オンデマンド配信】メールマーケティング基礎セミナー<br>名刺とホームページとメールを使った新規顧客拓について

【オンデマンド配信】メールマーケティング基礎セミナー
名刺とホームページとメールを使った新規顧客拓について

マニュアル

オンデマンドセミナー

オンデマンドセミナー

【オンデマンド配信】マニュアル制作のプロが教える!業務マニュアル書き方セミナー

【オンデマンド配信】マニュアル制作のプロが教える!業務マニュアル書き方セミナー

マニュアル

オンデマンドセミナー

オンデマンドセミナー

【オンデマンド配信】社内システムのマニュアル作成担当者様にオススメ! プロが教える 読み手に伝わるシステム操作マニュアルの作り方セミナー

【オンデマンド配信】社内システムのマニュアル作成担当者様にオススメ! プロが教える 読み手に伝わるシステム操作マニュアルの作り方セミナー

マニュアル

オンデマンドセミナー

オンデマンドセミナー

【オンデマンド配信】「i-Share®DX」紹介セミナー

【オンデマンド配信】「i-Share®DX」紹介セミナー

マニュアル

オンデマンドセミナー

オンデマンドセミナー

【オンデマンド配信】DX推進の強い味方! マニュアル自動作成ツール「Dojo」とは?

【オンデマンド配信】DX推進の強い味方! マニュアル自動作成ツール「Dojo」とは?

マーケティング

オンデマンドセミナー

オンデマンドセミナー

【オンデマンド配信】複数のWebサイトを管理・運営しているお客様向け 学校・介護向け、複数施設のサイト運営・管理の方法

【オンデマンド配信】複数のWebサイトを管理・運営しているお客様向け 学校・介護向け、複数施設のサイト運営・管理の方法

マーケティング

オンデマンドセミナー

オンデマンドセミナー

【オンデマンド配信】Webサイトリニューアルの手順とポイント

【オンデマンド配信】Webサイトリニューアルの手順とポイント

マニュアル

オンデマンドセミナー

オンデマンドセミナー

【オンデマンド配信】マニュアル改善セミナー 『シリーズ2 マニュアル作成のためのルールづくり』

【オンデマンド配信】マニュアル改善セミナー 『シリーズ2 マニュアル作成のためのルールづくり』

マーケティング

オンデマンドセミナー

オンデマンドセミナー

【オンデマンド配信】これからGA4移行に取り組む 担当者向け『旧GAとの違いと移行のポイント』

【オンデマンド配信】これからGA4移行に取り組む 担当者向け『旧GAとの違いと移行のポイント』

マーケティング

オンデマンドセミナー

オンデマンドセミナー

【オンデマンド配信】Webサイトの管理に取り組む担当者向け「GA4とUAの違いとGA4のレポート作成」

【オンデマンド配信】Webサイトの管理に取り組む担当者向け「GA4とUAの違いとGA4のレポート作成」

マニュアル

イベント

DX EXPO【2023SUMMER】【東京展】東京ビッグサイト

DX EXPO【2023SUMMER】【東京展】東京ビッグサイト

マニュアル

イベント

バックオフィス DXPO 東京2023 【東京ビッグサイト】

バックオフィス DXPO 東京2023 【東京ビッグサイト】

マニュアル

イベント

バックオフィス DXPO 福岡2023 【マリンメッセ福岡】

バックオフィス DXPO 福岡2023 【マリンメッセ福岡】

マニュアル

イベント

ODEX 第3回デジタル化・DX推進展【インテックス大阪】

ODEX 第3回デジタル化・DX推進展【インテックス大阪】

マニュアル

イベント

DX 総合EXPO 2023大阪WINTER【大阪南港ATCホール】

DX 総合EXPO 2023大阪WINTER【大阪南港ATCホール】

マニュアル

イベント

DX総合EXPO 2024 SPRING【東京ビッグサイト】

DX総合EXPO 2024 SPRING【東京ビッグサイト】

マニュアル

イベント

バックオフィスDXPO 大阪'24【インテックス大阪】

バックオフィスDXPO 大阪'24【インテックス大阪】

プリント&デリバリー

イベント

【5月11~12日】星が丘テラスで開催のワクワクぷりんと博覧会に出展いたします。

【5月11~12日】星が丘テラスで開催のワクワクぷりんと博覧会に出展いたします。

過去のイベント・セミナー一覧

Useful content for KWIX

クイックスのサービスを導入された
お客様の事例をご紹介

お客様に役立つ
有益な情報のご紹介