ユーザードキュメントにスクリーンショットを含める必要がありますか？
この質問は、コードのドキュメントではなく、userのドキュメントに焦点を当てています。
私はソフトウェアプロジェクトを完成させたところです。私が働いている人々は、ソフトウェアのすべてを説明するユーザードキュメントを書くことを期待しています。
彼らが今まで持っていたすべてのドキュメント（彼らが使用する残りのソフトウェアについて）はスクリーンショットでいっぱいで、テキストがほとんど含まれていない場合があります。ひどいと思います。スクリーンショットがどのように接続されているかを理解するために何時間も苦労してきました。ほとんどの場合、誰かに助けを求める必要がありました。
私はJavaデスクトップアプリケーションを書いており、その外観は現在のWindowsテーマとJavaアップデートに依存している可能性があります。スクリーンショットが信頼できるものとは思わない、決定的な参照。
何百ものスクリーンショットを取り、それらに注釈を付けることは永遠にかかります、そして私がそれが正確でプレーンテキストのドキュメント以上に役立つとは信じていません。
ユーザードキュメントをまとめるにはどのようにアプローチすればよいですか？スクリーンショットの使用とユーザードキュメントを使用したテキストでの説明に関してどのガイドラインに従う必要がありますか？
スクリーンショットは、ユーザーガイダンスの重要な側面です。ただし、明確で正確な指示も添付する必要があります。たとえば、スクリーンショット、ボタンを指す赤い矢印、「ファイル名を入力したので、Nextボタンをクリックします」というテキストが表示されているスクリーンショットがあるとします。テキストやスクリーンショットだけの場合よりもはるかに明確です。
クリックごとの適切なガイドを実行するには時間がかかりますが、エンドユーザー（技術的なものも含む）のサポートに関しては価値があります
「絵は千の言葉を伝える」という古い格言は、ここほど重要なことはめったにありません。どうぞ、あなたのために、そしてあなたのユーザーのために：スクリーンをたくさん使ってください。
私のユーザーのほとんどが高齢者の女性である同様の状況にあったので、私はスクリーンショットがどれほど有用であるかを伝えることができません。問題は、それらをどのように提示するかです。タスクベースのアプローチが最も効果的であることがわかりました。
例えば.
目次
- 顧客情報
- 顧客の住所を更新したい
- 請求
- 顧客の請求書を作成したい
- 顧客の請求書を作成したい
- 運送
- あなたはアイデアを得ます
TOCの各見出しは明らかにリンクです（Word/html/chm /サポートするものならどんなフォーマットでも）。次に、個々のアクション（例：1.1）ごとに、アプリが開いたときに最初に表示される画面から始めます。
- ホーム画面から開始します
- [スクリーンショット]
- [顧客]をクリックします
- [「顧客」ボタンの周りに大きな赤い丸が付いたスクリーンショット]
- [顧客]ウィンドウに到着します
- [顧客ウィンドウのスクリーンショット]
- （注、偽の顧客のみでテストビルドを使用してください）
- [検索]をクリックします
- [「検索」ボタンの周りに大きな赤い丸が付いたスクリーンショット]
- 顧客の姓とダブルクリックの名前を入力します
- [検索ボックスに顧客の姓が表示されている検索ウィンドウのスクリーンショット]
- お客様の詳細画面が表示されます
- [お客様の詳細のスクリーンショット]
- 「編集」をクリック
等.
はい、この最初のいくつかの手順は冗長であり、全体が面倒なスクリーンシューティングです。ユーザーは、最初の1ページまたは2ページだけでページをめくるだけで慣れますが、仕事の初日、長期休暇、マット休暇、病気休暇など、何でも...ドキュメントで「[これ]を実行します」と表示されたら、[[これを実行する]をクリックします]をクリックし、詳細な手順を確認してください。
最初のステップは、「お客様の情報を確認したい」セクションにリンクされている「お客様のファイルを開く」です。注意してください、私はそれに切り替えました、そしてこれが非常に複雑であると感じた私のユーザーの大部分がいました。それが複雑だと気づかなかった人たちは、「ショートカット」を理解するのに十分気にかけませんでした。ヒントは次のとおりです：オーディエンスを知るおよびそれらについて何も仮定しない。
Joel Spolskyからの古い記事があります（私の人生の中で、私にはわかりません）は、バスルームの使いやすさと車椅子の補助バーについて語っています。議論の核心は、一部のユーザビリティ機能はすべての人に必要なわけではないということでした...しかし、利用可能であれば、誰もがそれらを使用して高く評価しています。私は、内部アプリの非常に明白なドキュメントがこのカテゴリに当てはまると確信しています。特に、オンラインでヘルプを検索できないことを考慮してください。
ユーザー自身がプログラマー/技術者である可能性が高いですか、スクリーンショットを少しだけ含めた正確な説明で十分です。
ただし、ユーザーが技術者以外の場合は、正確な説明を含むスクリーンショットが役立ちます。ほとんどの人は、説明でおそらく使用している技術用語にさえ気づいていないことに注意してください。コンピュータを使用している人にラジオボタンとは何かを尋ねてみてください。
結論：ユーザーによって異なります
正確なアプリケーションとその構造によって異なりますが、一般的には、私が見つけたスクリーンショットよりも多くのテキストが必要です。製品がユーザーにとって初めてのコンピューターの紹介になる場合を除き、クリックごとの説明を気にする必要はありません。ユーザーインターフェースが正常であると仮定すると、テキストを使用してほとんどの操作を実行する方法と、いくつかのスクリーンショットを説明できるはずです。
ユーザーインターフェースがあまり正気でないか、誤解を招くような場合は、問題を修正するか、スクリーンショットや、実際に製品を機能させる方法を示すアニメーションGIFを提供することができます。あなたはこれを提供する必要がありますに加えてただし、プレーンテキストがたくさんあります。