[対象技術名] Overview

このファイルは、対象のライブラリ・フレームワーク全体を説明するためのテンプレートです。
テンプレート利用後は、[対象技術名] などのプレースホルダーを実際の内容に置き換えてください。

[対象技術名] とは

このセクションでは、対象技術が何のためのものかを短く説明します。
最初に一言で役割を書き、そのあとで「どんな場面で使われるか」を補足すると分かりやすくなります。

例:
[対象技術名] は、[できること] のために使われるライブラリ・フレームワークです。
[主な用途] のような場面でよく使われ、[関連技術] と組み合わせて利用されることもあります。

このセクションでは、対象技術でできる代表的なことを箇条書きで整理します。
細かく書きすぎず、「初学者が最初に知っておくとよい範囲」に絞るのがおすすめです。

例:

このセクションでは、どのような学習者や開発者に向いているかを書きます。
向いているケースと、最初は別の技術から入った方が分かりやすいケースがあれば、それも補足できます。

例:

このセクションでは、前提知識や準備しておくとよいことを書きます。
必須かどうかも分かるようにすると、読み手が不安になりにくいです。

例:

このセクションでは、このリポジトリをどの順番で読むとよいかを説明します。
docs/roadmap.md と役割が重なりすぎないように、ここでは考え方だけを簡単に書きます。

例:
まずは tutorials/00-getting-started/ で環境構築と最小構成を確認し、そのあとで基本概念と主要機能へ進むのがおすすめです。
細かい学習順序は docs/roadmap.md を参照してください。

このセクションでは、学習中によく出てくる重要な考え方を先に紹介します。
用語の厳密な定義は docs/glossary.md に任せ、ここではイメージをつかむことを優先します。

例:

このセクションでは、まず確認したい公式ドキュメントやガイドをまとめます。
情報の信頼性を保つために、できるだけ公式情報を優先してください。

例: