使う場面

ライブラリ、コマンドラインツール、社内サービスを公開するとき、最初の3つの問い、これは何か、どうインストールするか、どう実行するかに答えるドキュメントが必要な場面で、このテンプレートから始めましょう。開発者やレビュアーが読み、引き渡しパックの中でPDF化されたREADMEを受け取るクライアントも読みます。

含まれる内容

• プロジェクト名の入力欄から作られるタイトルと、その下に一文の説明です。
• シェルコマンドやコードサンプル用のコードブロックをそれぞれ備えた、インストールと使い方のセクションです。
• 大きな変更の前にIssueを開くよう案内するコントリビューションのセクションです。

より良い文書にするヒント

• 公開前に、クリーンな環境でインストールコマンドを試しましょう。最初の手順で失敗するREADMEは、多くの読み手を失います。
• このテンプレートはデフォルトでテクニカルスタイルを使い、コードブロックを等幅フォントで組み、エクスポート時も長い行をページ内に収めます。