プロジェクトの概要・インストール手順・使い方・ライセンスを 1 ファイルに集約します。GitHub ではリポジトリを開いたときにトップページへ自動表示されます。
技術用語
340
README.md
リードミー ドット エムディー
体験区分：触った
推奨読者レベル：Level 2-3
何をしてくれるか
どこで出会うか
GitHub でリポジトリを開くとコード一覧のすぐ下に表示されます。AI エージェントも「最初に読むファイル」として参照するため、渡す前に整備しておくと効果的です。
構造図
2026.04·ready
「README.md を整えてから AI に渡すと、最初の挙動の精度が上がります。」
README.mdの見方
341
この用語の見どころ
1
役割
プロジェクトの目的・手順・規約を一元化する説明ファイルです。
2
うれしさ
整備すると AI が初回から文脈を把握し、指示の精度が上がります。
3
注意点
概要を書かず手順だけ列挙すると、何のプロジェクトか伝わりません。
4
どこで役立つか
共同開発・AI エージェントへの引き渡し・OSS 公開時に効果があります。
5
はじめに
ファイル名は大文字 `README.md` が慣習で、GitHub が自動認識します。
6
深掘り先
CLAUDE.md、Markdown、git
非エンジニアのつまずき
- 英語ベースで読む気になれず .md の拡張子にも最初は抵抗がありました。
- 書くべき箇所とそうでない箇所の境界が最初は微妙に分かりにくかったです。
私のコメント
- 第一印象:最初に読むものだけど、ドキュメントだけでは読む気がしない。
- 良い点:エージェントが作ってくれるので自分で触らずに済みます。
- ダメな点:バージョン管理が甘いと古い情報が残りがちで管理が課題です。
- 誰向けか:アプリを作る人・使う人どちらにも関係します。
開発フローでの位置
リポジトリ作成
概要記入
手順整備
AI 引き渡し
継続更新
関連用語
F-59·term_tool
バイブコーディング図鑑