ユーザーガイド

ウィキペディアから、無料の百科事典
ナビゲーションにジャンプ 検索にジャンプ

ユーザーガイドは、一般にユーザーマニュアルとも呼ばれ、ユーザーが特定の製品、サービス、またはアプリケーションを使用するのを支援することを目的としています。これは通常、技術者、製品開発者、または会社のカスタマーサービススタッフによって作成されます。

ユーザーガイドは、多くの場合、家電製品の購入に含まれています。しかし今では、サービス、ソフトウェア、アプリケーションの両方で共通しています...ハードコピーまたはソフトコピー(ドキュメントまたはアプリケーション)で公開されています。

ほとんどのユーザーガイドには、書面によるガイドと関連する画像の両方が含まれています。コンピュータアプリケーションの場合、通常、ヒューマンマシンインターフェイスのスクリーンショットが含まれ、ハードウェアマニュアルには、明確で簡略化されたが含まれていることがよくあります。使用される言語は、専門用語を最小限に抑えるか、徹底的に説明し て、対象読者に一致させます。

ユーザーマニュアルの内容

ユーザーマニュアルのセクションには、多くの場合、次のものが含まれます。

  • 表紙
  • タイトルページと著作権ページ
  • 関連ドキュメントの詳細とユーザーガイドの操作方法に関する情報を含む序文
  • コンテンツページ
  • 目的セクション。これは、ドキュメントの目的を詳しく説明するのではなく、概要にする必要があります
  • オプションを含む、読む必要のある対象読者を明示的に示すオーディエンスセクション
  • スコープセクションは、対象外であるものと対象となるものを示す免責事項としても機能するため、非常に重要です。
  • 少なくともシステムの主な機能の使用方法に関するガイド
  • 発生する可能性のあるエラーまたは問題の詳細と、それらを修正する方法を説明するトラブルシューティングセクション
  • FAQ (よくある質問)
  • さらにヘルプが必要な場所、および連絡先の詳細
  • 用語集と、大きなドキュメントの場合索引

歴史

アンティキティラメカニズムのモデルに刻印されたユーザーガイド。

ユーザーガイドは、古代のデバイスで発見されています。一例として、アンティキティラメカニズム[1] 1900年にギリシャのアンティキティラ島の沖合で発見された2、000年前のギリシャのアナログコンピュータがあります。このデバイスの表紙には、メカニズム。

ソフトウェア業界が発展するにつれ、ソフトウェアプログラムを最適に文書化する方法の問題は未定でした。ユーザーは現在のヘルプドキュメントに不満を感じることが多いため、これはソフトウェア開発者にとって固有の問題でした。[2]この時点で開発されたユーザーガイドを作成する際の考慮事項は次のとおりです。

  • 平易な言葉の使用[2]
  • 長さと読みの難しさ[2]
  • デジタルプログラムの印刷されたユーザーガイドの役割[3]
  • ユーザー中心設計[3]

コンピュータソフトウェアのマニュアルとガイド

ほとんどの重要なソフトウェアアプリケーションのユーザーマニュアルとユーザーガイドは、上記のリストと同様の内容の本のようなドキュメントです。それらは、印刷物または電子的に配布することができます。一部のドキュメントは、多くの内部リンクを備えたより流動的な構造になっています。GoogleEarthユーザーガイド[4]はこの形式の例です。ガイドという用語は、ソフトウェア製品の特定の側面に対応するドキュメントに適用されることがよくあります。いくつかの使用法は、インストールガイドスタートガイド、およびさまざまなハウツーガイドです。例として、Picasaスタートガイドがあります。[5]

一部のビジネスソフトウェアアプリケーションでは、ユーザーのグループがアプリケーションの全機能のサブセットにのみアクセスできるため、グループごとにユーザーガイドが用意されている場合があります。このアプローチの例は、Autodesk Topobase 2010ヘルプ[6]ドキュメントです。このドキュメントには、個別の管理者ガイドユーザーガイド、および開発者ガイドが含まれています。

も参照してください

参照

  1. ^ 「2、000年前の古代ギリシャのコンピュータのためのBoffins解読マニュアル」2018年11月29日取得
  2. ^ a b c Chafin、Roy(1982年1月)。「ユーザーマニュアル:ユーザーは本当に何を必要としているのか?」SIGDOC '82システムドキュメンテーションに関する第1回年次国際会議の議事録:36–39 –ACMデジタルライブラリ経由。
  3. ^ a b マッキー、ジョン(1986年8月)。「印刷されたコンピュータユーザーマニュアル:彼らには未来がありますか?」ACM SIGDOC Asterisk Journal ofComputerDocumentation12:11–16 –ACMデジタルライブラリ経由。
  4. ^ 「GoogleEarthユーザーガイド」グーグル。2009年6月4日2009年8月13日取得
  5. ^ 「Picasa入門:入門ガイド」グーグル。2009年6月15日2009年8月13日取得
  6. ^ 「AutodeskTopobase2010ヘルプ」オートデスク2009年8月13日取得