変数機能

複数言語の用語登録と変数対応が可能です！

マニュアルのコンテンツの一部を変数で一元管理することで、マニュアル更新作業のヌケモレを減らし、マニュアルの品質向上につなげることができます。「PMX」の変数機能はCSVでデータを保持していますので、特に、

• 用語集など情報量が多い場合
• 製品リストやスペック表など、頻繁に更新が必要な情報がある場合
• 問い合わせ先や会社情報など繰り返し使用する情報がある場合

といった内容を含むマニュアルの場合、該当箇所のCSVを更新することで各コンテンツが自動的に置き換えられるため、修正漏れや表記ゆらぎの防止につながり大変有効です。表記ゆらぎを防止することで、多言語対応の際の誤訳発生を抑制できるだけではなく、過去に翻訳したコンテンツとの整合性も取りやすくなります。

CSVはシンプルで汎用性が高い形式であり、担当者はExcelやGoogleスプレッドシートなどを使って簡単に情報を更新できます。そのため、技術的な知識がなくてもデータの修正作業ができ、また記述方法もシンプルなものであるため、属人化を防止することもできます。
また、変更点をCSV上で確認できるため、マニュアル全体を確認する必要がなく、影響範囲の把握やレビュー作業にかける時間を短縮できます。特に製品名や型番、注意書き、法的表記、免責文など、正確性が求められる情報においては、修正漏れにより事故などが発生すると、訴訟対象にもなりかねません。CSVでデータを一元管理することは「チェックが容易になる」という点に限らず、情報の信頼性を担保するということにつながるため、マニュアルの更新スピードの向上だけでなく、常に最新の情報、かつ品質の高いマニュアル作成が可能になり、顧客の安心感にもつながるため、顧客ロイヤルティが向上します。

マニュアル作成システム「PMX」の変数機能では、単一の用語登録だけではなく、英語や中国語など複数の言語ごとに用語設定を行うことが可能です。これにより、変数機能を多言語の用語集としても活用できるため、CSVの情報を言語や状況に応じて柔軟に差し替えることができ、より効率的に複数言語のコンテンツ管理が実現できます。言語コード別に記載された用語情報をCSVファイルでアップロードすることで、トピック内の指定箇所が変数として自動的に置き換えられます。

多言語対応が必要な場面では、同じ用語に対して国や地域ごとの仕向情報が必要な場合があります。CSVであれば行単位で情報を管理することができるため、複数言語で構成されるマニュアルコンテンツの一元管理や更新作業の簡素化が可能となり、運用負荷の低減やヒューマンエラーの削減にもつながります。

▼PMXが言語判定し、自動で対象言語の値を出力します。

変数は単語に限らず文章も利用できます！

マニュアル作成システム「PMX」の変数機能は、単語に限らず、文章単位でも使用できます。変数で文章を使用できるメリットは、文章も「データ」として管理できる点です。コンテンツに直接文章を書く場合、複数コンテンツで共通の文章があると修正時の影響把握が難しく、修正漏れが発生しやすくなります。例えば、注意書きや免責文、繰り返し使用する定型文など、複数コンテンツで共通して使用される文章を変数化してCSVで一元管理することで、表記ゆらぎの防止にもつながり、修正作業を最小限に抑えることができます。

また、変数で文章を使用できるということは、多言語マニュアルにおいても適しています。国や地域によって、注意書きや免責文、法的表現が異なるケースは少なくありません。それらの情報はCSVにて文章単位で管理しておけば、同じキーワードに対して言語別・仕向け別の文章を一行でデータ管理することができ、言語に応じて適切な文章を自動的に切り替えることができます。法改正などに伴い文言修正が発生した場合も、CSV上の文章を更新するだけで多言語マニュアルの該当箇所が一括反映されるため、修正漏れを防ぐことができます。

▼多言語マニュアル用CSVの出力イメージの一例

マニュアル作成システム「PMX」の変数機能では、一つの値につき全角半角問わず1,000文字まで設定可能です。1,000文字以内であれば、table要素やa要素などのソースコードを設定することもできますので、小さな表やリンク付きのURLアドレスなども変数として管理することができます。これにより、マニュアル全体のデザインや記載ルールを統一しやすくなり、マニュアル利用者にとって読みやすく、理解しやすいコンテンツ作成につながります。

▼CSV内にa要素を設定すると、出力したときにリンクとして表示されます。