エンドユーザーのドキュメントの例とアドバイスのための適切なリファレンス[終了]

10

私たちの社内ソフトウェアは多くのユーザーに使用されており、トレーニング部門はエンドユーザーのドキュメント形式のヒントを求めてきました。

トレーニング部門がインスピレーションを得るために使用するソフトウェアエンドユーザードキュメントの良い例や、良いアドバイスがあるサイトがどこにあるか知っていますか？

これはこの質問に似ていますが、技術者以外のユーザーが使用するエンドユーザードキュメントを探しています。

design  documentation  users 
— ジョン
ソース
1
「ソフトウェアエンドユーザードキュメントの良い例はどこにありますか」ステップ1.ソフトウェアを購入します。手順2.ドキュメントを読みます。すでに使用している既存のソフトウェアからドキュメントを入手できない理由は何ですか？ほとんどのエンドユーザーパッケージには完全なドキュメントがオンラインであると思います。MicrosoftのOfficeスイートのドキュメントを読むのを妨げているものは何ですか？
— S.Lott、2011
私が読んだドキュメントのほとんどは、読むのに魅力的ではない方法で書かれていると思います。私が持っている本のほとんどは、一般に技術的な読者を対象としたプログラミング関連です。誰かが最後にMicrosoftのマニュアルを読んだときを見てください。したがって、私はいくつかの感動的な例を探していました。
— ジョン
うーん、面白いq。
— ルーク
@ジョン：「ほとんどのドキュメント」。はい。では、「ほとんど」を破棄した後、何が残っているのでしょうか。地球上で最もよく使用されているドキュメントの一部を「読みたくない」と拒否する理由はわかりません。あなたは苦情のリストを拡大し、「読まない」テストで除外されないソフトウェア文書の例の個人的な短いリストを追加するかもしれません。私たちはあなたのことをよく知りませんので、なぜあなたが「読みたいと思わない」ということを意味するのか推測できません。
— S.Lott、2011
2
ローカライズされてほとんどの人に当てはまらない「良い」という特定の基準を持つ質問を要求しないように注意してください。私は配色には興味がありません。
— JeffO、2011年

回答:

1

まず、社内ユーザーにソフトウェアについてインタビューを行い、知りたい情報の種類を調べます。

私がソフトウェアについて書いたドキュメントの多くは、1人または多くの読者を想定しています。トレーニング部門は、トピックのスケルトン（TOCなど）の恩恵を受ける可能性があります。したがって、どのトピックが関連し、何が彼らのトレーニングの目的に無関係であるかについて話し合うことができます。

トピックのいくつかをカバーすることができます：

  1. 対象読者
  2. 技術要件
  3. インストールする方法（該当する場合）
  4. プロセス（つまり、ソフトウェアはどのようなビジネス機能を実行しますか？）
  5. 機能セット（ソフトウェアにはどのような機能がありますか？）
    • たとえば、ユーザーの追加やドキュメントの追加など、タスクベースのアプローチが考えられます。
    • あなたはオブジェクトベースのアプローチ、例えばユーザー、ロールを持つことができます
    • メニューベースのアプローチが可能です。たとえば、ファイルメニュー、表示メニュー
  6. 最後に、今後の機能とFAQセクションは、製品の知識リポジトリとして機能する可能性があります。

ソフトウェアの開発に関する知識、ソフトウェアの機能に関する知識、および（できれば）エンドユーザーへのインタビューに基づいて、エンドユーザーがソフトウェアをどのように使用するかを予測してください。

最も重要なことは、読みたいドキュメントを作成し、楽しい例の名前を使用してデモンストレーションを行い、注釈付きのスクリーンショットをたくさん使用することです。

お役に立てれば

— きのこ
ソース
2

私はいくつかの「エンドユーザーガイド」を読み、1つ作成しましたが、その効果を向上させる要素はたくさんあると思います。

  • コマンドを発行したり、アクションを実行したりする方法を画像で示します（スクリーンショットなど）。
  • 何かをする必要性と、それを成し遂げる方法に焦点を当てます。たとえば、そのアクションがどのように最適化されるかについての技術的な説明は避けてください。
  • モジュールを説明するフロー図を配置すると、ソフトウェアが分割され、あまり役に立たないというコメントを受けました。
  • ユーザーが抱えている可能性のある問題を予測して、トラブルシューティングのセクションが役立つようにしてください。また、他のプロジェクトに目覚めた同僚でさえ、開発に関与していないユーザーでプログラムをテストする必要があります。
  • 退屈な説明は避けてください。それ以上の情報は付録またはそのようなものに入れることができます。

これがお役に立てば幸いです。

— ニコラス
ソース
1

あなたはそれが訓練のために使われると言っています。

参照ドキュメントではなくトレーニングドキュメントを探している場合、私のお気に入りのサイトはJoel SpolskyによるMercurialのチュートリアルです。

  1. シンプルでクリーンなプレゼンテーション。見ていてうれしいです。
  2. 権威がありますが、個人的な口調です。あなたは素晴らしい大学の講義をしているように感じます。
  3. 実際のスクリーンショットの大量ではなく、単純な写真。これが機能する理由については、「ナプキンの裏側」をお読みください。

あなたがトレーニングドキュメントをJoelのMercurialチュートリアルの1/2ほどかっこいいとしたら、私はそれを読むでしょう。しかし、上記の3つのポイントをコピーできたとしても、a）執筆への情熱とb）それを引き出すための信じられないほどの深い知識を持つ人が必要です。それがうまくいくことを願っています。

— マイクランド
ソース
0

これがあなたのニーズに合うかどうかはわかりませんが、オンラインドキュメントの作成を容易にする技術的なドキュメントスフィンクスに使用されているシステムがあります。このようなものをあなたが興味を持っているものに使用できますか？

また、ほとんど同じことをするReadTheDocsに遭遇しましたが、これはホストされたソリューションです。

— パイパー・メリアム
ソース
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.