トピックライティングによるドキュメンテーション

「トピックライティング」は、「トピック指向ライティング」とも言われます。印刷する冊子単位で制作し、デザイン重視の「ブック指向ライティング」とは異なり、コンテンツの構造に従って部品化された「トピック」という単位で原稿を入稿・編集するライティング手法であり、それぞれ制作フローや考え方が異なります。
ここでは、トピックライティングに関する基本的な考え方や、ブック指向ライティングとの違いについて触れています。

トピックライティングの概要とメリット~Webマニュアルにも最適!

「トピックライティング」は、「トピック指向ライティング」とも言われ、マニュアルやトリセツ(取扱説明書)などのテクニカル・ドキュメントの代表的なライティング手法です。「トピック指向ライティング」は、印刷する冊子単位で作成する「ブック指向ライティング」とは異なり、コンテンツの構造に従って部品化された「トピック」という単位で原稿を入稿・編集します。昨今のWebマニュアル(HTMLマニュアル)対応も比較的スムーズに行うことが可能であることから、導入する企業が増加しています。

製造業をはじめ、様々なメーカーやソフトウェアベンダーなどでは、製品のライフサイクル短縮に伴い、新製品の投入や仕様変更が頻繁に行われるようになっています。しかし、このスピードにマニュアル(取扱説明書)の制作スピードが追い付いていないという問題が起こっています。それは、マニュアル制作の現場が、属人的な制作スタイルになっている事に起因します。さらに、マニュアル制作は、改訂・チェック・校正・承認・版管理・翻訳と言った様々なプロセスが存在するにもかかわらず、特定の担当者に作業が集中してしまい、その結果、製品リリース前後でドキュメント部門の制作負荷が急激に上がり、その影響でミスが多発するという問題も起こっています。

このような属人的な制作プロセスを見直し、分業化・標準化を進めるには、「ブック指向ライティング」から「トピック指向ライティング」へマニュアル制作スタイルに転換し、制作プロセスを見直す必要があります。

トピックライティングのメリットは以下の通りです。

  • ドキュメント制作スタイルの標準化を図り、品質と生産性が向上する。
  • トピック単位でのドキュメント再利用が容易になり、流用率を高めることが可能。
  • トピックの共通化を図り、改訂時の編集・校正の重複やミスを排除することが可能。
  • トピック属性を利用した条件分岐や出力の制御が可能になり、システム化・自動化が容易になる。
  • ドキュメント構造とデザインを分離するため、様々な形式へ同時に出力することが可能。

トピックライティングは、章・節・項・注意書きなど、意味のある単位でドキュメントを「構造化」するところから始めます。そして、この構造化した最小単位のドキュメントを「トピック」と呼びます。また、トピックには様々な「属性」を付与することができ、マニュアルやトリセツ(取扱説明書)の管理者は、トピックの再利用や表示/非表示の動的な制御をすることができます。

マニュアルやトリセツ(取扱説明書)の制作者は、トピックライティングで作成したトピックをマップというインデックスに関連付けする事でアウトプットの形にまとめます。マップにはトピックを関連付けるだけではなく、マップ自体を関連づけることで、入れ子構造とすることも可能です。

また、トピックと同様に、再利用性や検索性を高めるために、マップにも様々な属性を付与する事ができます。

Word・FrameMaker・DTPソフトなどでトピックライティングを行う場合

トピックライティングを行う際、本来は構造化された前提で、CMSや何らかのシステムなどによりライティングを進める方が、高い品質で制作を進める事が可能です。しかしながら、従来のDTPソフトやWord・FrameMakerによるライティングも可能ですが、その際、色々と注意点があります。CMSなどを利用する際と比べ、どのような違いがあるのでしょうか。

一つ目の違いは、InDesign・Word・FrameMakerのようなドキュメンテーションツールは、自由度が高い反面、トピックライティングの「構造化」を意識しなくてもドキュメントの作成ができてしまう点にあります。これらのツールは、書式スタイルや構造化の設定を行う事ができますが、利用者の多くはその機能や設定を使うことなく、あるいは担当者によってばらばらの構造やスタイルで、執筆・編集をしているのが現状です。その結果、標準化されないアウトプットが作成されてしまいます。

二つ目の違いは、トピックライティングは、トピック単位で編集しますが、InDesign・Word・FrameMakerは、ページ単位でドキュメントを編集する場合が多い事にあります。しかし、編集中のファイルに対して複数の編集担当者が同時に作業することができないため、改訂ピーク時にはオペレータの手待ちが発生し、チームとしての作業効率が極端に低下してしまうケースが発生します。また、ドキュメント内のテキストや図版が特定しにくい・ページが増えると検索が遅くなるなど、管理上の問題も発生します。

トピックライティングではなく、ブック指向ライティングのライティング手法であれは、従来からあるDTPソフト・Word・FrameMakerなどで十分でしょう。しかしながら、近年のドキュメンテーションは、ライティング手法をブック指向からトピック指向へ移行する動きが活発になっています。それは、紙からWebへ、あるいはDX・マルチメディア、といった流れにも即した、自然な流れである、とも言えます。

御相談、ご質問はこちら

お気軽にご相談ください

製品カタログ・セミナーでの講演資料など、豊富な資料がダウンロードできます

最新事例の公開情報や、イベント・セミナー情報をお届け

pagetop ボタン