手続き型コンテンツは、ユーザーが GitHub を使用している間に、最初から最後までタスクを完了するのに役立ちます。
より大きな記事内に手続き型記事と手続き型セクションを作成します。
手続き型記事の記述方法
手続き型コンテンツ テンプレートについては、「テンプレート」をご覧ください。
- 手続き型手順については、「スタイル ガイド」のスタイル ガイドラインに従ってください。
- 手続き型コンテンツが繰り返される場合があります。関連するコンテンツを 1 つのより長い記事にグループ化する機会を探してください。
- そうしない理由がない限り、複数の関連する手順を 1 つの記事にグループ化します。
- 設定を無効にするかタスクを元に戻すときに同じ手順が必要であり、特別な影響がない場合は、別の手順を記述しないでください。
- 設定を無効にするかタスクを元に戻すときに異なる手順が必要であるか、重要または特別な影響がある場合は、両方の手順を含むより長い記事を作成します。 依存しないタイトルを使用します。
- 手順の予想される結果を閲覧者に伝えます。
- トラブルシューティングのヒントをできるだけ頻繁に含めます。
手続き型コンテンツのタイトル
- 記事内の手続き型記事または手続き型セクションはタスク ベースであり、動名詞で始まります。
- 使用する: 「学生開発者パックへの応募」
- 能動態の具体的な動詞を使用します (ブレーンストーミングを行うか、必要に応じて類義語辞典を使用)。
- タイトルは特に記事またはヘッダーに含まれるタスクを記述するものですが、すべてのコンテンツを反映するのに十分な一般的なものです。
- 記事タイトルの長さ: 最大 80 文字、可能な場合は 60 文字。