作業を開始するコンテンツは、GitHubの製品と機能の使用に関するエントリ ポイントを提供します。 このセクションには、概念とハウツーに進む前に、ユーザーが必要とする最小限の重要な情報のみが含まれている必要があります。 これは簡潔にするためであり、機能を使い始めるだけで複雑そうに見えないようにするためでもあります。
開始にあたっての考慮事項
「はじめに」は、簡単かつ短時間でざっと目を通せる記事群です。 含まれる記事は 5 個未満で、理想的には次の 2 つだけです。
- クイック スタート
- [PRODUCT] について (または "Product とは")
これに対する 1 つの例外は、利用可能なプランと課金情報であり、製品または機能を使用するためにそのような情報が必要な場合があります。
クイック スタート コンテンツの詳細については、「 クイック スタート コンテンツ タイプ」を参照してください。
特に、この情報を含む記事は、[はじめに] には含めるべきではありません。
- ハウツー コンテンツ タイプに該当する記事。
- セットアップまたはサインアップの手順: これらはハウツーでもあります。 UI で何かを行う方法について説明します。
- 特定の機能を使い始めるのに役立ちますが、製品領域全体には役立たないコンテンツ。 この種のコンテンツは、より適切に概念に属しています。
- ベスト プラクティス(通常)。 機能を初めて使用するユーザーには、これらを最大限に活用するために必要なコンテキストがありません。