トピックライティングをマニュアル作成システム「PMX」で実施

「トピックライティング」は、「トピック指向ライティング」とも言われます。従来から存在する、デザイン重視の「ブック指向ライティング」とは異なり、コンテンツの構造に従って部品化された「トピック」という単位で原稿を入稿・編集するライティング手法です。
マニュアル作成システム「PMX」によるドキュメンテーションでは、どのようにトピックライティングを実現できるのでしょうか?

マニュアル作成システム「PMX」でトピックライティング

サイバーテックのマニュアル作成システム「PMX」は、マニュアルやトリセツ(取扱説明書)、技術文書や論文、約款や規定集などの構造化ドキュメントを編集・管理・出力するための機能を持ったコンテンツ管理システム(CMS)です。

マニュアル作成システム「PMX」では、Webブラウザ上でブログへ投稿するのと同じような操作で使える「トピックエディタ」により、構造化コンテンツである「トピック」を作成します。マニュアルの編集担当者は「PMX」の「トピックエディタ」を使用するにあたり、高度なDTPの知識や、XMLあるいはDITAのスキルは不要で、トピックライティングの基本的な考え方を理解するだけで構造化ドキュメントの作成が可能です。

例えば、コンテンツの構造を指定するには、「スタイル」メニューの「アウトラインスタイル」から「見出し・章・項・節・脚注」などを選択するだけです。また、コンテンツ内の見た目を指定するには、「スタイル」メニューの「インラインスタイル」から「囲み罫・外枠」などを選択するのみで実施できます。

トピック編集機能のスタイル選択画面
▲トピック編集機能のスタイル選択画面

さらにトピックエディタでは、「下線・強調・囲み罫・ルビ・上付き/下付き・脚注・リンク指定」といったテキストスタイルの設定やスペック表のような複雑な表の作成や編集も、編集ボタンを選択するだけの簡単操作で行え、出力用スタイルシートを充てることにより、編集途中のまま出力が可能となる、WYSWYGエディタとしての機能も有します。ライティング作業は全てWebブラウザ上で行われるため、アウトプットが電子マニュアルとなる場合の親和性が非常に高い結果となります。

トピック編集機能のボタン
▲トピック編集機能のボタン

トピックエディタの機能

サイバーテックのマニュアル作成システム「PMX」では、カンタンに文書の構造化が実現できます。Web入稿したコンテンツは、本システムで文章を構成する最小単位(=トピック)となり、トピックの複製・流用を簡単に行うことができます。トピックは階層化することができ、例えば章にあたるトピックの配下に節にあたるトピックを作成していく、といった使い方も出来ます。

トピックエディタでは、テキスト編集の他に、図版の挿入・構造の指定・スタイル付けを行うことができます。また最新バージョンでは、数式(MathML3.0)のサポート、ルビ、脚注編集への画像登録機能、HTMLソースの直接編集機能を搭載しました。トピックエディタは、学習参考書や教材コンテンツの制作だけでなく、マニュアル(取扱説明書)や技術標準文書・規格票などのドキュメンテーションに最適な「トピックライティング」に対応しているため、制作・編集現場の業務効率化を実現します。

さらに、「PMX」では、トピックに属性情報を付与することができます。属性情報は、「製品型番」「シリーズ名」「事業所名」など、項目は自由に決める事ができます。これら属性情報は、トピックを分類、検索する目的で使用できます。このトピック属性は、「PMX」導入時に、お客様の要望を取り入れて設定します。

その他、「PMX」には、トピックの版管理をする「バージョン管理機能」や、複数名によるチームドキュメンテーションを可能とするワークフロー機能、複数の言語を管理する「多言語管理オプション」、Tradosなどの翻訳支援(CAT)ツールとの連携機能、MS Wordファイルを一括してトピックとして登録する「Word一括登録オプション」など、豊富な機能を有しています。

既存のマニュアルデータを移行~Word・DTPデータでもトピックライティング

サイバーテックでは、出来るだけお客様の現場部門(制作ご担当者様)、もしくは委託先の制作会社様で運用中の、従来のDTPやFrameMaker、Wordなどを使った「ブック指向ライティング」から「トピック指向ライティング」へスムーズに移行して頂くサポートを実施しております。例えば、「トピック指向ライティング」の導入を決めた後、具体的なタスクに落とし込むフェーズのアドバイスやサポートをはじめ、トピックライティングを行う際に必ず検討が必要となる

「既存ドキュメントやマニュアルの構造化を実施して欲しい」

「制作会社や翻訳会社との役割分担はどう変わるのか」

「昨今ニーズが高まっている電子マニュアルやWebマニュアルへの対応も検討したい」

といった課題に対して、お客様のプロジェクトに参画して、具体的なテーマを一緒に解決する、コンサルティングサービスやアドバイザリサービスも実施しております。

御相談、ご質問はこちら

サービスご案内資料や、特別資料「マニュアル作成の効率化とコストダウンを実現するポイントとは? 」がダウンロードできます。

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

pagetop ボタン
サイバーテックお知らせ画像
©2003 CyberTech corporation ltd. All Rights Reserved.