【コラム】エンジニア視点からユーザー視点へ – 実現するわかりやすいマニュアル
みなさん、こんにちは。ヒューマンサイエンス ドキュメントソリューション部の吉本です。
突然ですが、みなさんはマニュアル制作の中で以下のようなお悩みはありませんか？
「マニュアルがあるのに問い合わせ数が減らない。」
「マニュアルに記載されているのに、ユーザー側での操作エラーが多い。」
もしかすると、それはマニュアルがエンジニア視点で記載されているからかもしれません。
今回は、マニュアル制作時に大切な「視点のシフト」をテーマに、わかりやすいマニュアルを作成するためのヒントをお伝えします。
- 目次
1. 脱エンジニア視点の重要性
IT企業の現場において、とかくエンジニアがマニュアルの制作に関わることは少なくないのではないでしょうか。そのため、現場で作成されるマニュアルはどうしても「エンジニア視点」になりがちです。
例えば、システムの仕組みや機能に関する「専門性の高い」説明の結果、ユーザーにとってわかりにくい内容となってしまうことも少なくありません。そのため、カスタマーサポート、ヘルプデスクなどへの問い合わせを増やし、社内の負荷が大きくなります。何よりも顧客満足の低下にもなりかねません。
ユーザー視点へのシフトを目指すことは、企業の評価を高めるうえでも重要なことなのです。
2. ユーザーにとって分かりやすいマニュアルを書くには？
前章では視点をユーザーにシフトすることの重要性をご紹介しました。この章ではユーザーにとって分かりやすいマニュアルを書くために必要な視点ご紹介します。 もし読者の皆さんの手元に運用されているマニュアルがあれば、以下の視点から現状のマニュアルを分析してみてくだいさい。
視点①：伝える目的
マニュアルの目的に合った作りになっているかを考えましょう。 「マニュアル対象者は誰ですか？ユーザーに何をさせたいですか？使用シーンを考えた作りになっているでしょうか？」このような観点で分析すると目的がはっきりしてきます。
視点②：マニュアル対象者に親切
用語や専門用語の選定、文章の表現などは、読み手の知識のレベルに合わせて調整する必要があります。必要に応じて技術的な部分は適切に解説し、できるだけ平易な表現を用いることで、より多くのユーザーにアプローチできます。
視点③： 検索性の良い構成
文章の構成や表現はユーザーが追いやすいように工夫する必要があります。 論理的な順序で手順を説明し、箇条書きや図表などを活用して視覚的に分かりやすくすることが重要です。また、効率的なキーワードの配置や見出しの工夫によって、マニュアル内での検索が容易になるよう配慮すると、ユーザビリティが一層向上します。
いかがだったでしょうか？ これらの視点を意識することでユーザーにとって分かりやすいマニュアルを作成できるでしょう。
3. ユーザー視点へのシフト – APRESIA Systems様の取り組み例
ヒューマンサイエンスが過去にWebマニュアルを作成させていただいた事例をご紹介します。 APRESIA Systems様は、社会インフラソリューション、セキュリティソリューション、情報システム運用管理ソリューション等々、情報システムインフラに更なる付加価値を提供する情報システム専業会社として、私たちの生活や社会の発展を支えておられます。
ヒューマンサイエンスは、APRESIA Systems様のイーサネットスイッチ「ApresiaNPシリーズ」のマニュアル作成を2015年からお手伝いしてまいりました。「ApresiaNPシリーズ」は、高度に進化した企業ネットワーク向けに、セキュリティー管理やQoS機能を搭載しつつ、ローコストを実現した次世代L2、L3スイッチです。
APRESIA Systems様では従来、開発やカスタマーサポートのエンジニアがマニュアル作成に携わってきました。
その中で、
「ユーザー視点でマニュアルのわかりやすさをどのように向上できるか」
「エンジニアが本来業務に注力しながら、品質のよいマニュアルを作成する仕組みづくりができないか」
等を検討してこられました。新製品を企画するにあたり、製品の付加価値向上の1つの施策としてマニュアルの品質改善に取り組まれました。
マニュアル改善プロジェクトにおいて当社が特に重視したのは、目次・プロト設計段階における目的・対象読者の明確化でした。
また、各校正時の目標品質・チェック観点をチェックシートで共有することにより、各作業プロセスの位置付けを明確にしながら制作を進めるよう心がけました。
今後の運用を見越して規準を整備することにより、一定の品質水準を保った制作を実現できたと感じております。詳しくは下記をご覧ください。
マニュアル制作事例|APRESIA Systems株式会社様|ヒューマンサイエンス
4. ユーザビリティを高めるプラットフォームの改善
これまでマニュアルのドキュメントをユーザー視点にシフトすることの重要性を取り上げました。
さて、皆さんは「ユーザビリティ」という言葉をご存知でしょうか。
ユーザビリティはWebサイトやソフトウェアなどにおいて、使いやすさを表す言葉です。常に時間に追われる現代人にとって、「使いやすさ」は市場でシェアを伸ばすための重要な要素になっており、マニュアルをWebで公開する際にも大切になります。
先ほどの3つの視点を参考にすると「使いやすい」Webマニュアルを作成できます。
視点①：マニュアルの目的
ユーザーの使用シーンを考えた作りにしましょう。多くの場合、アクセススピードの速さがユーザビリティに直接影響します。
視点②： マニュアル対象者に優しく
「シンプルなナビゲーション」にすることで情報の階層構造を明確にし、ユーザーが目的の情報に素早くアクセスできるようにできます。
視点③：検索性
サイト内に「検索機能」を組み込むことで、ユーザーが必要な情報を見つけやすくできます。また、「関連情報のリンク」を提供することで、ユーザーがより深い理解を得ることができます。
これらの視点を簡単にWebで実現できる方法があります。それはこれまで弊社が発信してきたJamstackの技術を使ったモダンフロントエンドです。
5. モダンフロントエンドで実現できるユーザビリティ
実際にモダンフロントエンドでWebマニュアルを構築することでどのようにユーザビリティを向上できるかをご紹介します。
スピード：モダンフロントエンドのメリットの一つは「速さ」です。静的サイト生成とCDNを活用することで、従来のサーバサイドレンダリングよりも高速なページロードを実現します。このスピードの速さは、マニュアルサイトでのユーザビリティを格段に向上させる要素の一つです。
ナビゲーション：モダンフロントエンドの一つの特徴は、静的サイトジェネレータとしての柔軟性です。これにより、容易にシンプルで直感的なナビゲーション構造を作り出すことができます。たとえば、HugoやGatsbyのようなジェネレータを使用して、情報の階層構造を明確にし、ユーザーが目的の情報へ素早くアクセスするルートを設計することができます。
検索機能：クライアントサイド検索サービスをAPIを使って組み合わせることで、高レベルな検索機能をサイトに追加できます。高速で信頼性の高いモダンな検索を提供するサービスの例としてAlgoliaがあります。検索対象となるデータをAlgoliaに登録すると、APIを経由して検索できるというわけです。
モダンフロントエンドは、ユーザビリティの向上を実現するためのマニュアル構築に非常に適しています。高速なアクセス、クリアな情報構造、効果的な検索機能は、ユーザーがマニュアルの内容を効率的に探索・習得するのに大きなメリットとなるでしょう。当社のサービスサイトでも詳しくご紹介しています。
6. ヒューマンサイエンスならマニュアル作成からモダンフロントエンドを使ったWeb構築まで一貫して対応可能
いかがでしょうか。今回はユーザー視点でマニュアルを作成する方法をご紹介しました。ユーザー視点にシフトすることは、サポート対応の負荷を軽減することや、製品の付加価値向上にもつながります。
本コラムの内容でさらに詳しくお知りになりたい方は是非当社へお問い合わせください。 ヒューマンサイエンスは、1985年以来、数多くのマニュアルを作成してきた実績を持っています。まさに、業務マニュアル作成におけるプロフェッショナル集団です。業務マニュアルの作成でお困りのことがあれば、お気軽にご相談ください。
特長①：大企業・グローバル企業を中心に豊富なマニュアル制作実績
ヒューマンサイエンスは、製造業やIT業界を中心に製造業やIT業界を中心に、多岐にわたる分野でマニュアル制作実績を積み重ねてきました。
これまでに「ドコモ・テクノロジ株式会社」「ヤフー株式会社」「ヤマハ株式会社」など、名だたる企業をクライアントとしてきました。
特長②：経験豊富なコンサルタントによる調査・分析からアウトプットまで
業務マニュアル作成に携わるのは、ヒューマンサイエンスが誇る経験豊富なコンサルタントになります。熟練のコンサルタントが、豊富な経験と提供された資料から、より分かりやすく効果的なマニュアルを提案します。また、情報が整理されていない段階からのマニュアル作成も可能です。担当のコンサルタントがヒアリングを行い、最適なマニュアルを作成いたします。
マニュアル評価・分析・改善提案サービス| ヒューマンサイエンス
特長③：マニュアル化だけでなく、定着支援も重視
ヒューマンサイエンスは、マニュアル作成にとどまらず、”定着化”という重要な段階にも注力しております。マニュアル作成後も、定期的な更新やマニュアル作成セミナーを通じて、マニュアルの定着を支援してまいります。多岐にわたる施策により、現場でのマニュアルの有効活用をサポートいたします。
最後まで読んでくださり、ありがとうございました。 このブログが見やすいマニュアル作りへのヒントになれば、うれしく思います。 次回のコラムでは、「WordからWebマニュアルへ – JamstackでWeb化する選択肢」について取り上げます。お楽しみに！
ページの先頭に戻る
03-5321-3111［東京］ 
お問い合わせ
お役立ち資料
