READMEは何のためにあるか
READMEは、成果物を見に来た人へ「これは何か」を伝える入口です。
コードを読む前に、目的・使い方・工夫点が分かるREADMEがあると、成果物の価値が伝わりやすくなります。
基本構成
| 見出し | 内容 |
|---|---|
| 概要 | 何を作ったか |
| 背景 | なぜ作ったか |
| 使い方 | どう動かすか |
| 使用技術 | 何を使ったか |
| 工夫点 | どこを考えたか |
| 今後 | 次に改善したいこと |
悪い例
Todoアプリです。
良い例
学習予定を忘れないためのTodoアプリです。
スマホでも入力しやすいように、フォームを大きくしました。
注意点
技術名を並べるだけでなく、なぜ使ったかを書きます。読み手は、コード全体を読む前に判断します。
まとめ
READMEは、成果物の説明書です。目的、使い方、技術選定、工夫点を書くと、ポートフォリオとして伝わりやすくなります。
← 一覧に戻るPR
PR