多くの場合、ユーザーが複雑なタスクを完了したり、関連するタスクのセットを理解したり、ワークフロー全体を説明したりするのに役立つ情報をコンテキストでグループ化すると便利です。 コンテンツの種類を組み合わせたより長い記事を使用して、ユーザーが適所でコンテキスト コンテンツを確実に見つけられるようにします。 より長い記事は、コンテンツの重複をなくし、製品に追加されるオプションが増えるにつれてコンテンツをスケーリングするための準備にも役立ちます。 ユーザーはほとんどの場合、製品を積極的に使用するときにより長い記事が必要になります。また、作業過程のさまざまな時点で記事の参照が必要になる場合があります。
記事内の複数のコンテンツの種類を組み合わせる方法
- より長い記事では概念、手続き型、参照、トラブルシューティング、または既知の問題のコンテンツを使用します。クイックスタートやチュートリアルは使用しないでください。
- 必要に応じて記事のさまざまなコンテンツの種類のセクションを使用し、そのコンテンツの種類のタイトル ガイドラインに従います。
- ほとんどの場合、これらの記事には、少なくとも 1 つの手続き型セクションと、少なくとも 1 つの追加の概念、参照、または手続き型セクションが含まれます。
- コンテンツの順序付けのガイドラインを使用して、記事内のヘッダーを整理します。
- トラブルシューティング情報はできるだけ頻繁に使用してください。
- 必要に応じて、ヘッダーで記事のタイトルをレプリケートできます。
複数のコンテンツの種類を組み合わせた記事のタイトル ガイドライン
- 記事内に手順がある場合は、動名詞で始まるタスク ベースのタイトルを使用します。
- タイトルは、記事に含まれる情報とタスクの範囲を説明するのに十分な一般的なものです。
- タイトルは、切り替えられる設定を説明するものであり、閲覧者が選ぶ設定に依存しません。たとえば、「プライベート リポジトリをパブリックにする」ではなく、「リポジトリの可視性を設定する」などとなります。