クイックスタートを使用すると、約 5 分または 600 語で重要な手順のみを含むワークフローを示すことで、個別の的を絞ったタスクをすばやく完了できます。 クイックスタートは、新しいツールですばやく設定したり、別のタスクをすばやく完了したりするために使用できます。 より複雑なタスクの場合は、チュートリアルを使用します。
クイック スタートは、他のユーザーが既に機能または製品を理解していて、試す準備ができている場合に役立ちます。
サイト全体でチュートリアルとクイックスタートをまとめて "ガイド" と言います。 /guides ランディング ページでは、ドキュメント セットのガイドのリストにチュートリアル、クイックスタート、特定の手続き型記事が含まれています。
クイックスタートの記述方法
クイックスタート テンプレートについては、「テンプレート」をご覧ください。
クイックスタートのコンテンツ:
- 概要:
- 次のような言い回しを使用して、このクイック ガイドが的を射たものであることを強調します。
- [機能] をプロジェクトにすばやく追加する
- [製品] の使用を開始するための要点
- [機能] に慣れているユーザー向けの簡易ガイド
- 対象ユーザーを明確にします
- 前提条件と必要な事前知識を明確に示します
- 誰かが達成または構築するものを示します
- 次のような言い回しを使用して、このクイック ガイドが的を射たものであることを強調します。
- 手続き型セクション
- クイックスタートの対象ユーザーに基づいて、手順は手続き型コンテンツで使用されるものよりも明示的で正式ではない可能性があります。 対象ユーザーがその詳細レベルを必要としない場合は、既存の再利用可能なものを使用してこれらの手順を形成する必要はありません。
- 情報の流れを妨げないように、他の記事やリソースをレプリケートするのではなく、それらにリンクします。
- 視覚的な手掛かりを示します。コード ブロックとスクリーンショットを頻繁に使用すると、ユーザーに正しいアクションを実行していると安心させるのに役立ちます。
- トラブルシューティング (省略可能)
- クイックスタートに関連するトラブルシューティング コンテンツが存在する場合は、そのコンテンツへのリンクを提供します。
- 次の手順
- 次の手順に移る手段として、クイックスタートで実行された内容を簡単に要約します。
- クイックスタートを完了した後に他のユーザーが実行できる 2 から 3 つのアクション可能な次の手順を含めます。 機能または製品の概念コンテンツに常にリンクします。 また、docs.github.com または GitHub Skills のその他の関連情報にリンクすることもできます。
クイックスタートのタイトル ガイドライン
- ガイドが新しいツールの使用を開始するのに役立つ場合は、タイトルの先頭に "クイックスタート" を付けます (例: 「GitHub Actions のクイックスタート」や「クイックスタート: 手続き型タイトル」)。
- その他のユース ケースでは、手順のタイトル ガイドラインに従い、"クイックスタート" という単語を省略します。