製品ドキュメント
ユーザーがアプリケーションで実行できるタスクを完了するのを支援します
ユーザーに、アプリケーションの操作方法を説明する実践的なガイドを提供し、タスクの完了を支援します。
製品の機能を、実践的な手順に変換します。
- ガイドスコープを準備します
ドキュメントの各セクションと、その対象読者をレビューしてください。
- コンテンツの質問に答える
ガイドが説明すべきワークフローと情報を明確にします。
- 公共サービスに従ってください
ビルドの進捗状況とドキュメントサイトのアドレスを確認します。
アプリケーションの使い方を説明します
ドキュメントは、製品プレゼンテーションを補完し、実践的な手順を提供します。まず、使い始め方を説明し、次に、アプリケーションが実際にサポートするワークフローについてユーザーをガイドします。
ドキュメント構成では、セクションの定義と質問が公開されます。タスクをユーザーの言語で説明するのに役立つコンテキストを提供します。
ガイドをアクティブなアプリケーションに接続したままにしてください。
最初の有用な操作をサポート. 「まずはここから」ガイドは、新規ユーザーが製品を簡単に使い始めるためのものです。どこから始めるか、どのような情報が必要か、そしてどの結果がタスクの完了を示すかを説明する必要があります。
定期的なワークフローを説明します. 実際のアプリケーションのラベルと操作に基づいて、詳細なガイドが続きます。前提条件、番号付きのステップ、および期待される結果により、一般的な画面の説明を解釈することなく、誰かがビジネス タスクを再現できるようになります。
横断的な質問に答えてください. いくつかの質問は、1つの画面ではなく、アカウント、コスト、または公開に関するものです。FAQには、簡潔な回答と関連するガイドへのリンクが記載されており、手順がサイト全体に重複するのではなく、1か所にまとめています。
製品にガイドを接続したままにしてください
意味のあるアプリケーションの変更を行った後、ドキュメントを確認してください。ガイドでは、ユーザーが実際に確認できるラベルと動作を使用する必要があります。
ドキュメントは、独自のパブリックサービスで実行されます。ウェブサイトからリンクし、プロジェクトで公開する言語のガイドを確認してください。
ユーザーが次のタスクを完了するのを支援します
実践的なガイドでは、どこから始めればよいか、どのような情報が必要か、結果をどのように確認するかを説明します。その価値は、読者がアプリケーションで行動するのを支援することにあります。
タスクが複数の領域にまたがる場合は、関連するガイドを参照して操作を続けます。画面が変更された場合はドキュメントを確認し、指示が変更後も引き続き役立つようにします。
合意された機能から、役立つサポートへ
ガイドスコープの準備. ドキュメントの各セクションと、それらが説明すべきタスクを確認してください。対象ユーザーとアプリケーションの動作を明確に保ちます。
不足しているコンテキストを入力してください. 前提条件、ルール、結果について説明します。実際のインターフェースを使用し、架空のコントロールは使用しないでください。
公開後のレビューと変更. アプリ内のガイドに従い、その言語と関連リンクを確認し、基盤となるタスクが変更されたら、後で再度確認してください。
製品ドキュメントに関する質問
機能紹介ページは、見込み客がその機能とその価値を理解するのに役立ちます。ガイドは、実際のコントロール、前提条件、および結果とともに、ユーザーがタスクを実行するのに役立ちます。これらは互いに補完し合います。
ドキュメントツールは、セクション定義と質問を表示します。アプリケーションがサポートするタスクを確認し、不足している情報を提供し、作成状況を追跡してください。
プロジェクトは、その範囲で利用できるローカライズされたガイドを公開します。公開された各言語を確認し、完全な手順と正しいインターフェースラベルが維持されていることを確認してください。
タスク、そのコントロール、または予想される結果に影響を与える変更があった場合、元の指示が有効であると想定するのではなく、代わりに動作するアプリケーションでテキストを確認してください。
エンドポイント参照は、アクティブで機能するAPIを持つプロジェクトに属します。ライブ操作と実際の参照を使用してください。計画中のルートだけでは、使用可能な統合を文書化するには不十分です。