ハウツーには、 GitHub 製品を使用してタスクを実行する方法を説明する番号付き手順が含まれています。 一般に、 GitHubの使用を最大限に活用する必要があります。
ハウツー記事では、タスクを完了するための最低限必要な手順に焦点を当てています。 前提条件 (特に概念やリファレンス) または次の手順 (特にチュートリアル) として、他のコンテンツ タイプにリンクしている場合があります。 リンク戦略に従って、これらは明示的に有用で必要な場合にのみ使用する必要があります。
手順の前に、通常は1～2文程度の簡単な紹介文を含めます。 2、3 文以上の説明が必要な場合は、概念に関する記事として情報を追加することを検討してください。
トラブルシューティングは独自のコンテンツ タイプですが、ハウツー記事には、ユーザーがタスクを完了するのに役立つ短いトラブルシューティング セクションを含めることができます。
ハウツー記事のタイトル
記事内のハウツー記事のタイトルとセクションはタスク指向であり、動名詞で始まります。
- 「学生開発者用パックの申し込み」では積極的で具体的な動詞を使用してください（必要に応じてブレーンストーミングや類義語辞典の使用を行う）。 タイトルは特に記事またはヘッダーに含まれるタスクを記述するものですが、すべてのコンテンツを反映するのに十分な一般的なものです。
手順記事の短いタイトルには短くて動名詞を用いない動詞句を使用します。 短いタイトルがサイドバーナビゲーションに表示されます。
- 使用: "プランの管理" または "Copilot を使用して問題を作成する"
操作方法に関する考慮事項
ハウツー コンテンツ テンプレートについては、「 テンプレート」を参照してください。
- 手続き型手順については、「スタイル ガイド」のスタイル ガイドラインに従ってください。
- ハウツーコンテンツは、繰り返しが多くなることがあります。関連するコンテンツを1つの長い記事にまとめる機会を探しましょう。
- 説得力のある理由がない限り、複数の関連するハウツーを 1 つの記事にグループ化します。
- 設定を無効にしたり、タスクを元に戻したりするために同じ手順が必要で、特別な影響がない場合は、別の操作方法を記述しないでください。
- 設定を無効にしたり、タスクを元に戻したりするために異なる手順が必要な場合や、重要または特別な影響がある場合は、両方のハウツーを含む長い記事を作成します。
- 操作方法の意図した結果を常に含めます (通常、これはタイトルになります)。
- 既知の問題点にトラブルシューティングのヒントを含めます。
ハウツー コンテンツの例
-
[AUTOTITLE](/actions/using-workflows/using-starter-workflows)