ソフトウェアの操作マニュアルにおける、電子マニュアル化・動画対応・バージョン管理

Web(HTML)マニュアル/バージョン管理・・・●ユーザーズガイド●リファレンスマニュアル●オンラインヘルプ●FAQ●運用保守マニュアル

ソフトウェアのユーザーズガイド・システム運用保守マニュアル

ソフトウェア製品や情報システムは、他の工業製品などと比較した場合でも、機能追加やバグフィックスなどに伴うバージョンアップ・リビジョンアップの頻度は非常に高い傾向にあります。それに伴うソースコードの構成管理はしっかりなされていることが大半ですが、ドキュメントやマニュアルの構成管理も同時並行で実施されている場合はまだまだ少ないのではないでしょうか。

システムやソフトウェアにおけるユーザーズガイドや運用保守マニュアルなどのドキュメントは、たとえ一種類の製品やシステムであっても「機能別マニュアル」「用途別マニュアル」など、何種類ものマニュアルが同時進行で制作されます。バージョンアップやリビジョンアップの都度、それらを改版してゆくドキュメンテーション業務はエンジニアが行うことが多く、本来の設計・開発業務に割り当てなければならない貴重な工数を消費してしまうことにつながります。

特に、印刷を前提としたマニュアルではなく、オンラインヘルプやWebサイトから閲覧するWebマニュアル、あるいは静的HTMLで構成される電子マニュアルなどが重要視される傾向にある同分野において、上記のような課題を持つドキュメントやマニュアルは、例えば以下のようなものです。

ソフトウェアのユーザーズガイド

  • 企業向け・個人向けのソフトウェアのユーザーズガイド
  • システム開発者向けのリファレンスマニュアル・ホワイトペーパー
  • ソフトウェアのオンラインヘルプ

システム運用保守マニュアル

  • 監視マニュアル・トラブルシューティングマニュアル
  • 業務システムのオペレーションマニュアル

ソフトウェアのユーザーズガイド、システム運用保守マニュアルなどに「PMX」が向いている理由

マニュアル作成プラットフォーム「PMX」は、ソフトウェアベンダーが販売する製品に同梱するユーザーズガイドやマニュアル(取扱説明書)、あるいはシステムインテグレータが納入する業務システムの納品物の一部となる運用保守マニュアルやオペレーションマニュアルなどのドキュメントなど、様々なドキュメントやマニュアルの制作・管理において力を発揮するCMS(コンテンツ管理システム)です。

例えば、マニュアルに付随する大量の画面キャプチャを、バージョンアップの都度スクリーンショットを取ってMS Wordなどに張り付けていき、同時に文章を更新してゆく作業を繰り返すことは、変更点のヌケモレにより、マニュアルの改訂漏れが発生する可能性が高くなり、かつ貴重なエンジニアの工数を全て消費することにつながります。

マニュアル作成プラットフォーム「PMX」により、エンジニア側はバージョンアップ部分のキャプチャのみ素材サーバにUPしておくというフローに変更すると、編集者は該当画像が関連したコンテンツの最終調整のみを行えば良いので、作業分担がスムーズに行えるとともに、改版箇所もすぐにわかります。もちろん、キャプチャデータの構成管理も「PMX」でしっかり実施できます。

また、運用保守マニュアルの場合は、トラブルシューティングを効率良く行うために、紙のマニュアルとは別に、検索で該当箇所にすぐにたどり着くことができるデジタルコンテンツの形式で提供される必要があるため、紙マニュアルの校了後に電子マニュアル(HTMLマニュアル)の制作を短期間で行う必要がありますが、「PMX」ではPDFによる印刷用データと同時にHTML形式でマニュアルも出力することが可能なので、新たに電子マニュアルを作成する必要がありません。

さらに、近年ソフトウェアのマニュアルでは、利用者自身で課題解決できるよう電子マニュアル(Webマニュアル)や、オンラインヘルプ、FAQコンテンツなどの重要性が高まっていますが、HTML出力によるマニュアルからそれらに流用することも可能です。

ソフトウェアのユーザーズガイド、システム運用保守マニュアルの特長

  • 製品やシステムのバージョンアップやリビジョンアップが頻繁に発生する
  • 画面キャプチャによる画像素材が大量にある
  • HTML形式での提供が求められることが多い
  • FAQなど、マニュアルから派生するコンテンツが多い
  • いざという時、紙による出力も必要

このようにマニュアル作成プラットフォーム「PMX」は、IT分野に求められるドキュメントやマニュアルの制作効率化と改版・改訂情報の管理といったドキュメンテーション業務における課題を解決します。蛇足ながら「PMX」の操作マニュアル自身も同製品で作成されており、バージョンアップやリビジョンアップのつど、HTML出力による電子マニュアル・組版により印刷にも使えるPDF・MS WORD全てのフォーマットで出力できる環境が整備されています。

御相談、ご質問はこちら

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

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

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