[GitHub 100日チャレンジ] Day 97 - ドキュメントを完成させる

ドキュメントの役割

良いプロジェクトは、コードだけでなく説明も読めます。READMEは初めて訪れた人が最初に読む場所です。

READMEに入れる内容

• プロジェクト概要
• 主な機能
• 使い方
• セットアップ手順
• スクリーンショット
• 技術スタック
• 今後の改善案

再現できる手順を書く

以下の...はURLの省略を示す記号です。公開するREADMEには実際のclone URLを書き、clone後に作成されたフォルダへ移動するcdの手順も補います。npm run devで開くURLと、初期画面で何が表示されれば成功かまで書くと、初めて読む人が確認できます。

git clone ...
npm install
npm run dev

手順は自分以外の人が実行しても分かるように書きます。

今日のゴール

READMEを整え、第三者がプロジェクトの目的、使い方、動かし方を理解できる状態にしましょう。