1目次構成
ベースのマニュアルが存在する場合はそれを分析し、読み手の欲しい情報が一目でわかる目次に再構成します。また、マニュアルを新規作成する場合は目次案を提案します。いずれの場合も適切に目次を構成することで、読み手が使いやすいマニュアルに仕上がります。
テクニカルライティングとは？
設計・製造の要件定義書、仕様書、図面などからマニュアルを作成します。
マニュアル作成用の原稿を用意していただく必要はありません。
製品マニュアル作成で培った製品理解力により、設計段階の資料をもとにマニュアルを作成します。
テクニカルライティングとは、技術情報をユーザーにわかりやすく伝える技法のことで、情報を正確、明瞭、簡潔に、一貫性のある表現で伝えることが求められます。
弊社のテクニカルライティングサービスは製品の要件定義書、設計書、設計仕様書、設計図面、プロトタイプ製品による動作検証などをベースに、お客様に負担をかけることなく効率的にマニュアルを作成します。
こんな課題をお持ちではありませんか？
- BtoB製品の高品質なマニュアルを作りたい
- 具体的な予算やスケジュールは「やってみないとわからない」と言われてしまう
- 事前にやること、やらないことを整理してくれないので不安
- 論理的な根拠に基づいてマニュアルを構築してもらえない
- プロとしての改善提案がなく、こちらが言ったことしかやらない
- 専門的な知識、理解する姿勢がないので作成できない
課題の原因
作成フローやルール、運用ルールが決まっていない、決め方が分からない
マニュアル作成業務が属人化している
マニュアルの作成に必要な工数が分からない
どうしたら「分かりやすく」なるのか分からない
課題が及ぼす悪影響
納期遅延
設計/開発工数、チェック工数の増加
人件費の増加
ユーザーからのクレーム
問い合わせの増加
企業ブランドの低下
サポート費用の増加
管理工数の増加
残業の増加
そんな課題を解決します
- 既存のマニュアルをすべて検証します
- 既存製品、関連製品のマニュアルをお預かりし、評価します。数十ページを対象とした表面的な評価でなく、マニュアル全ページ、シリーズ全冊、全製品を対象とし、マニュアルのあり方全般について評価します。
- ヒアリングにより、潜在的な問題を探り出します
- マニュアル評価と同時進行する形で、お客様に対しヒアリングします。その中で、明確になっている問題と、そうではない潜在的な問題を探り出します。場合によっては、製品に対する問い合わせの記録（ユーザーからの問い合わせログ）を分析し、エンドユーザーの抱える問題を明らかにします。
- 評価やログ解析結果に基づき、評価レポートを提示します
- ヒアリング、マニュアル評価、ユーザーからの問い合わせログの解析結果に基づき、お客様のマニュアル作成に関わる問題・課題を報告します。
- 問題点と課題に対する改善案を提示します
- 評価結果を提示するだけでなく、問題や課題に対する改善案として具体的な目次、原稿、デザインのサンプルを作成します。また、改善した場合の費用やスケジュールなどを併せて提示します。これにより、成果物の具体的な姿と費用を確認してから作成を始められます。
改善案の提示例
-
マニュアル作成フローの見直し
-
ターゲットユーザーを
明確にしたマニュアルの作成方針 -
マニュアルの媒体・提供方法、分冊・合本化の施策
-
改善版の目次構成、原稿見本、
表記・表現の統一化ルール -
本文レイアウト、表紙デザイン、
イラスト・写真などの品質見本 -
ツールなどの利用によるスピードアップ、
コストダウンの手法
テクニカルライティングの作成フロー
2本文サンプル
マニュアル本文の実際の紙面構成を提示します。記載内容、記載の粒度、用語、表記・表現、画面や図・イラストの大きさ・使い方、全体的なデザインを確認していただきます。
3スタイルガイド、表記・表現ルール
マニュアルを構成する要素について、見出し、説明文、操作文、注意文など、その役割ごとに書き方のスタイルを決めます。
4作成費用とスケジュール
ご支給いただいた資料・情報にもとづき、作成費用やスケジュールを提示します。
5執筆
目次構成、ルールにもとづき本文を執筆します。
多数の協力会社や翻訳者から、マニュアルの分野、ドキュメントタイプに応じて最適なライターを選定し、作業を行います。決めた仕様やルールを順守できているか、ケアレスミスがないかなど、密なコミュニケーションをとりながら進行します。
6クライアント校正
作成したマニュアルをご校正いただきます。
執筆作業中に発生した不明点については、コメントシートやお打合せで解消しながら進行いたします。
7完了
マニュアル作成完了です。
ご校正時にフィードバックいただいた場合は過不足なく反映し、作業完了です。
テクニカルライティングの効果
情報が正確、明瞭、簡潔に、一貫性のある標準化されたマニュアルとなります。
読み手にとってわかりやすく、知りたい情報を的確に探せるマニュアルです。
- 設計/開発工数の削減
- 管理工数の削減
- 問い合わせの削減
- 人件費削減
- マニュアルの標準化
- マニュアルの流用効率増加
テクニカルライティングで
提供できる成果物
テクニカルライティングでは、標準化されたマニュアル、属人性を排除しつつ運用するためのルール、
作成したデータのデータベース化など、マニュアルを作成、活用していくうえで必要な様々な成果物を作成します。
-
マニュアル
標準化されたマニュアルを提供できます。モジュール化を意識し、トピック単位で作成するので流用効率の向上が見込めます。
-
マニュアル作成基準の構築
用語集や表記・表現のルールを構築することによって、マニュアルの品質の維持・管理に役立てることができます。
-
コンテンツのデータベース化
コンテンツをデータベース化することによって、紙、タブレット、スマートフォンなど、媒体を選ばずにマニュアルを利用できます。
テクニカルライティングが
できること
マニュアルの翻訳だけでなく、マニュアルを軸にしたデータの活用、
作成・運用ルールの統一化などをもとに、御社が抱える様々な課題を解決します。
-
マニュアルのライティング
ルールにもとづき作成することで、標準化されたマニュアルを作成します。
-
動画マニュアルの活用
Webヘルプ形式のマニュアルに動画を組み込むなど、マニュアルを軸としたサービスをご提供します。
-
マニュアルの統一化
マニュアルに関するルールを作成することで、属人性を排除し、統一されたマニュアルを作成することが可能となります。
よくある質問
-
どのようなドキュメントが作成できますか？
-
取扱説明書、設置マニュアル、メンテナンスマニュアル、整備マニュアル、作業手順書、ヘルプなどを作成いたします。当社が最も得意とするマニュアルの「テクニカルライティング」はメーカー向けの「操作説明書」、「メンテナンスマニュアル」です。詳しくはお問い合わせください。
-
テクニカルライティングとは、どのようなことをしてくれるサービスですか？
-
マニュアルの執筆作業をご提供しております。
製品マニュアル作成で培った製品理解力により、設計段階の資料をもとにマニュアルを作成します。
当社では、執筆作業のみでなく、既存マニュアルの課題点や見直しと合わせてご依頼いただくことをお勧めしております。
この工程を踏むことで、お客様ごとのお悩みに最適なマニュアルのあり方をご提案させていただくことが可能です。
-
メーカーでない人がライティングができるのでしょうか？
-
当社のテクニカルライターの多くは、元技術者です。
事前に仕様書やマニュアルを熟読し、既存マニュアルの構成や書き方を把握したうえで作成したルールに則って書きますのでご安心ください。最先端の技術情報などは、ヒアリングや取材等のご協力をお願いしておりますが、事前に設計段階の仕様書などを熟読して臨みますのでご安心ください。