ユーザーガイド

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

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

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

ユーザーマニュアルのセクションには、次のような内容が含まれることがよくあります。

表紙
タイトルページと著作権ページ
関連文書の詳細とユーザーガイドのナビゲーション方法に関する情報を含む序文
目次ページ
目的のセクション。これは文書の目的を詳しく説明するのではなく、概要を示すものである必要があります。
対象読者が誰であるかを明示的に示すための読者セクション（オプションを含む）
範囲セクションは、何が範囲外か、何がカバーされているかを示す免責事項としても機能するため、非常に重要です。
少なくともシステムの主要機能の使い方に関するガイド
発生する可能性のあるエラーや問題とその解決方法を詳しく説明したトラブルシューティングセクション
FAQ （よくある質問）
さらなるサポートの入手先と連絡先
用語集と、大きな文書の場合は索引

歴史

古代の装置にはユーザーガイドが添付されていたことが見つかっています。その一例がアンティキティラ島の機械^[1]です。これは2,000年前のギリシャのアナログコンピューターで、 1900年にギリシャのアンティキティラ島の沖合で発見されました。この装置の表紙には、機械の特徴と操作方法を説明する文章が書かれています。

ソフトウェア業界が発展するにつれ、ソフトウェアプログラムをどのように文書化するのが最善かという問題は未解決のままでした。これはソフトウェア開発者にとって特有の問題であり、ユーザーは現在のヘルプドキュメントに不満を抱くことが多かったのです。^[2]当時開発されたユーザーガイドの作成に関する考慮事項には、次のようなものがあります。

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

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

たとえば、Unix以前のGCOSでは、メインフレームのドキュメントは印刷されたページで、ユーザー (スタッフ、学生など) がオンプレミスで利用でき、スチール製のバインダーにまとめられ、1 つのモノリシックなスチール製の読書ラックにまとめてロックされ、テーブルやカウンターにボルトで固定され、ページはモジュール情報の更新、置き換え、正誤表、および補遺用に整理されていました。^{[引用が必要]}

ほとんどの重要な PC およびブラウザソフトウェアアプリケーションのユーザーマニュアルとユーザーガイドは、上記のリストに類似した内容の書籍のような文書です。これらは印刷物または電子形式で配布されます。一部の文書は、多くの内部リンクを含むより流動的な構造になっています。Google Earthユーザーガイド^{[4]はこの形式の例です。}ガイドという用語は、ソフトウェア製品の特定の側面を扱う文書によく適用されます。インストールガイド、スタートガイド、さまざまなハウツーガイドなどの用法があります。例としては、Picasaスタートガイドがあります。^[5]

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

参照

参考文献

^ 「科学者が2,000年前の古代ギリシャのコンピューターのマニュアルを解読」。 2018年11月29日閲覧。
^ abc Chafin, Roy ( 1982 年 1 月)。「ユーザーマニュアル: ユーザーが本当に必要とするものは何ですか?」。第 1 回国際システムドキュメンテーション会議 (SIGDOC '82) の議事録。pp . 36–39。doi : 10.1145 /800065.801307。ISBN 089791080X. S2CID 6435788。
^ ab McKee, John (1986 年8 月)。「印刷されたコンピュータユーザーマニュアル: 将来はあるか?」ACM SIGDOC Asterisk Journal of Computer Documentation。12 ( 2 ): 11–16。doi : 10.1145/15505.15507。S2CID 35615987。
^ 「Google Earth ユーザーガイド」。2009 年 6 月 4 日。2009 年8 月 13 日閲覧。
^ 「Picasa を使い始める: 入門ガイド」 2009 年 6 月 15 日。 2009 年8 月 13 日閲覧。
^ 「Autodesk Topobase 2010 ヘルプ」。Autodesk。2009年8 月 13 日閲覧。

[1] 「科学者が2,000年前の古代ギリシャのコンピューターのマニュアルを解読」。 2018年11月29日閲覧。

[:0-2] Chafin, Roy ( 1982 年 1 月)。「ユーザーマニュアル: ユーザーが本当に必要とするものは何ですか?」。第 1 回国際システムドキュメンテーション会議 (SIGDOC '82) の議事録。pp . 36–39。doi : 10.1145 /800065.801307。ISBN 089791080X. S2CID 6435788。

[:1-3] McKee, John (1986 年8 月)。「印刷されたコンピュータユーザーマニュアル: 将来はあるか?」ACM SIGDOC Asterisk Journal of Computer Documentation。12 ( 2 ): 11–16。doi : 10.1145/15505.15507。S2CID 35615987。

[4] 「Google Earth ユーザーガイド」。2009 年 6 月 4 日。2009 年8 月 13 日閲覧。

[5] 「Picasa を使い始める: 入門ガイド」 2009 年 6 月 15 日。 2009 年8 月 13 日閲覧。

[6] 「Autodesk Topobase 2010 ヘルプ」。Autodesk。2009年8 月 13 日閲覧。