IT製品・サービスの操作マニュアル作成代行

ソフトウェアやIT製品のマニュアル作成代行が求められる背景

企業間競争の激化とともに、提供される製品やサービスは多様化の一途をたどっています。特に、素早いリリースが求められる、ソフトウェア製品やクラウドサービスといったIT製品の操作マニュアルは、設計などを実施したエンジニア側でも作成することも可能ですが、エンジニアはあくまで製品やサービスの設計や開発のプロであるため、どうしても専門用語を多用してしまったり、説明をはしょってしまいがちではないでしょうか。特にクイックリファレンスのような、出来るだけ平易に表現することが求められるマニュアルにおいては、側や提供側の視点で作成すると説明不足になりがちであり、操作方法に限らず、伝えておくと利便性が高まる事でユーザーロイヤリティも高まるような情報など、読み手になかなか伝わらない事も多々あります。

一方で、マニュアル作成自体はプロフェッショナルであっても、対象製品や業務、分野によって、マニュアル作成ベンダーには得手不得手があります。例えば、工作機械などのメカトロニクス系マニュアルは強い、一般消費者向けのユーザーズマニュアルは強い、といった製品ごとの得意分野を有するマニュアル作成ベンダーや、多言語マニュアルは強い、といった横展開が強いマニュアル制作ベンダーといった具合に、自社が得意とする領域のマニュアル制作は、業務知識や専門用語の取り扱いにも長けているため、高いクオリティと低コストを両立することが一般的です。

昨今では、工作機械や一般消費者向けの製品であっても、ソフトウェアが組み込まれている場合が大半であり、機会全体の操作マニュアルとは別に、IT分野に明るく、かつ読み手を意識したライティングが求められるケースが増加傾向にあります。しかしながら、IT分野の進化は早く、分野的にも新しい部類となるため、ITとマニュアルの両方を熟知したライターがまだまだ少ないのが現状であり、それらの分野を得意とするマニュアル作成ベンダーもさほど多くない現状があります。ソフトウェアやクラウドサービスのマニュアルは、その分野に長けたマニュアル制作の専門ベンダーに一任し、エンジニアは製品設計やプログラミング～テストといった製品開発や機能強化、あるいはIT製品やサービスの企画立案、といった本来の業務に集中することにより、メーカー側はさらに良い製品開発やサービス提供に注力いただけます。

マニュアル作成代行（ソフトウェアやIT製品）サービスの概要

マニュアル作成代行（ソフトウェアやIT製品）サービスは、お客様が開発・販売されるソフトウェア製品やクラウドサービスなどのIT製品に付随する操作マニュアルを当社が作成代行するサービスです。担当させて頂くのは、いずれもIT分野に明るいメンバーばかりですので、ソフトウェアやクラウドサービスに関するカンタンなオリエンテーションを実施頂くのみで、手離れ良くマニュアル作成をご依頼頂けます。

マニュアル作成をご依頼いただくに際して、稼働環境をお借りする、あるいはクラウドサービスのテストアカウントを発行頂き、実際に操作しながらマニュアルを作成することも可能です。システムやサービスが開発中であり存在しない場合は、設計ドキュメントなどをお借りした上で、全く何もないところからシステム操作マニュアルを起すことも可能です。そのような事が実施可能であるのは、ITベンダーであり、マニュアルにも携わってきた当社ならではのサービスです。

また、IT製品やサービスはどうしてもページ数が膨らみがちになりますが、本体のマニュアルとクイックリファレンスを分ける方法を推奨させて頂く場合もございます。むろん本体マニュアルは既存のものをそのまま活用いただく形で、クイックリファレンスのみを切り出して作成する、といった事も可能ですし、読み手の属性などに応じて、PDFで提供することを想定した上でMS Word等で作成することも可能ですが、HTML形式のマニュアルをご希望の場合であってもご対応可能です。作成するツールに関しては、弊社が開発および販売を行っているマニュアル用CMS「PMX」で実施させていただく場合もございますし、MS Wordなどのデスクトップ製品で作成する場合もございます。具体的には、マニュアルの更新頻度や読み手の属性などをふまえ、御社のご要望をお伺いした上でご提案させていただきます。

マニュアル作成代行（ソフトウェアやIT製品）サービスの特徴

ソフトウェア設計書から、あるいは実際に操作を行いながらマニュアル作成が可能

詳細設計書や画面遷移図、画面キャプチャデータといった、システムに関する設計書をお預け頂くことで、ライターがシステムイメージを考えた上でマニュアル作成を行う事が可能です。それらのドキュメントが存在しない、あるいは貸与頂けない場合であっても、テストアカウントを発行頂ければ、実際に操作をしながらマニュアルライティングを行う事が可能です。ソフトウェアやクラウドサービスのマニュアル作成を委託頂く際は、ITとマニュアルのプロフェッショナルである弊社であれば、お客様にとって最小限のオリエンテーションを実施いただくのみで、後は弊社ライターが、極力難易度を下げた「読んでもらえるマニュアル」の作成をドンドン進めてまいります。ライティングツールはMS Wordをはじめとするご指定のデスクトップツールで作成いたします。

HTMLマニュアルなどの電子マニュアル（Webマニュアル）だけではなく、紙ベースのマニュアルにも対応可能

HTMLマニュアルやオンラインヘルプなどの、e-manualと言われる電子マニュアル（Webマニュアル）は、特にソフトウェアやクラウドサービスの分野において広く普及していますが、印刷～製本までは行わないにせよ、俯瞰性の観点から、あるいはユーザーからのリクエストにお応えするといった観点から、PDF形式でのマニュアル提供が必要となる場合もあるのではないでしょうか。当社が作成するマニュアルでは、当社自身が開発および提供を行っているマニュアル作成支援システム「PMX」をマニュアル作成ツールとしてライティング時に活用することにより、最新のデバイスに対応したテンプレートに対応できるだけではなく、電子マニュアルとPDF組版によるデータの両方をご提供することが可能となります。

マニュアル作成のワンストップ対応だけではなく、お客様側で改訂出来るよう、システム自体のご提供も可能

ソフトウェア製品やクラウドサービスは、バージョンアップの頻度やスピードも速いかと思いますが、それらに付随するマニュアルの改訂自体は自社内で行ったほうが費用も掛からずスピーディに行うことが可能です。作成したマニュアルコンテンツは当社が開発および提供を行うマニュアル作成支援システム「PMX」内のデータベースで一元管理しておりますので、お客様にアカウントをお渡しすることでライティン～データ出力といった改訂作業はお客様の手でいつでも実施頂くことが可能です。マニュアル作成支援システム「PMX」はインストール不要のWebブラウザだけで操作できるクラウドサービスとしてご提供も可能となっており、MS Wordライクな多機能のWebエディタを搭載しておりますので、ブログを作成する際のエディタに似たインターフェイスとなります。したがってFrameMakerやInDesignといったAdobe製品に代表されるDTPの知識や、XMLやDITAといった、マニュアルライティングに求められる専門知識は不要です。

マニュアル作成代行（ソフトウェアやIT製品）サービスの内容

ソフトウェア、クラウドサービスやIT製品のマニュアル作成サービスの流れは以下の通りとなります。

1. マニュアル作成に必要な情報の確認（概要のヒアリング）

マニュアル作成のご依頼を検討頂いているお客様のご要望は、マニュアル作成や改訂自体を単にアウトソースされたいというものから、章立てや目次構成を含めたマニュアルとしてあるべき姿として全体的な見直しを行いたい、といったコンサルティング部分まで含めたものまで様々です。まずはご要望をお伺いした上で、現在のマニュアルや素材、ソフトウェア詳細設計書や画面遷移図、画面キャプチャデータといったものをお借りする必要がある場合は、NDA（秘密保持契約）の締結もお申しつけください。

2. 対象となるシステムやクラウドサービスの調査～お見積り

頂いた情報を元に、概算費用のお見積りを行います。ソフトウェアの仕様書だけでは把握が困難なシステムやクラウドサービスの場合、テストアカウントを発行いただき、そちらを拝見する場合もございます。開発中のシステムやクラウドサービスの場合は、そもそも拝見可能となるものがございませんので、独自のマニュアル制作プロセス～完成形をイメージした上でご提案いたします。

3. マニュアル作成費用と成果物の調整～ご発注

マニュアル作成の費用や成果物に関する調整を行わせていただきます。ご発注頂いた後は速やかにマニュアル作成作業に入らせて頂きます。機能性重視のマニュアルの場合、作成ツールは当社が開発および提供を行うPMXで実施いたしますが、デザイン重視の場合は、従来型のDTPツールにより実施する場合もございます。いずれの場合も、その後の改訂やメンテナンスをお客様側で実施されることを想定し、たいていの場合はデータをそのままお渡しすることを想定し、マニュアル作成を実施いたします。

4. マニュアルの納品～レイアウトなどの最終調整

マニュアルの一次納品を実施させていただき、当初お約束させて頂いた修正ポリシーや回数に従って、マニュアルの修正を実施いたします。スピード重視となるソフトウェアやクラウドサービスのマニュアルに特有となる、さまざまな変更のご依頼に対しても、ITベンダーである当社にとってある程度予見される範囲が把握可能であるため、それらの部分は修正ありきでまずはご覧頂く、といった流れを取らせて頂く場合もございます。

5. マニュアル作成の完了～データのお渡し

最終調整が完了したマニュアルデータを納品いたします。PDFとWebマニュアル（HTMLマニュアル）形式の両方で納品する場合は、今後のメンテナンスを想定した場合、PMXによる制作が最適となりますが、改訂の有無や頻度にもよりますので、そのあたりについて伺った上で、制作環境のご要望がありましたらそのままご提供いたします。

マニュアル作成代行（ソフトウェアやIT製品）サービスの事例・価格

スマートフォンアプリで提供されるサービスの操作マニュアル作成

CMSのクラウドサービスを操作しながら、操作マニュアルを新規作成

上記は一般的なマニュアル作成代行（ソフトウェアやIT製品）サービスの事例となります。そのほか多数の事例がございます、詳細はお問合せください。

マニュアル作成代行（ソフトウェアやIT製品）サービスのQ&A

ソフトウェアやクラウドサービス向けのシステム操作マニュアル作成にまつわる、次のような課題をお持ちではありませんか？