README.mdの書き方：AIやCodexに既存サイトを直してもらう前の整理メモ
README.mdは、GitHubで見栄えよく見せるためだけのファイルではありません。小さなWebサイトをAIやCodexに直してもらう時は、サイトの目的、公開方法、触ってよい範囲、触らない秘密情報、確認手順をまとめる作業メモになります。
この記事では、一般的なREADMEの構成に加えて、ロリポップやFTPで公開しているサイト、PHPやCSSを少しずつ直しているサイトで、AIへ安全に相談するためのREADMEの書き方を整理します。
確認日とこのページの使い方
確認日: 2026年6月23日。GitHubに置いたWebサイトや学習用プロジェクトを、ChatGPTやCodexへ相談する前に、README.mdへ何を書くかを整理するページです。
このページは、Copicodeの実サイト運用、GitHubでの作業履歴、AI/Codexへ既存サイト修正を頼む時の安全確認をもとに、初心者が秘密情報を出さずに状況を伝える順番へ整理しています。
このページで整理できること
- README.mdに、サイトの目的、公開方法、作業範囲、確認手順を書く
- AIやCodexに貼ってよい情報と、貼ってはいけない秘密情報を分ける
- FTP、ロリポップ、自作PHPサイトの更新メモをREADMEへ安全に残す
- AIコード安全確認、Codex作業範囲メモ、自作PHP保守へつなげる
README.mdとは？プロジェクトの「説明書」
`README.md`とは、GitHubリポジトリにアクセスした人が最初に目にする、プロジェクトの概要や使い方を説明するためのファイルです。ファイル名の末尾にある`.md`は、Markdown（マークダウン）という、簡単な記法で文章を構造化できるフォーマットの拡張子を意味します。
優れたREADMEは、訪問者に対して以下のような重要な情報を伝える役割を果たします。
- このプロジェクトは何をするものか？
- どんな問題を解決するのか？
- どうやってインストールし、使うのか？
- どうすればこのプロジェクトに貢献できるか？
つまり、READMEはあなたのプロジェクトの「第一印象」を決める、非常に重要なドキュメントなのです。
AIやCodexに見せるREADMEで先に書くこと
AIにコード修正を頼む時、READMEが一般的な紹介文だけだと、AIは公開方法、触ってよい範囲、触ってはいけないファイルを判断できません。既存サイトを直す目的なら、最初に次の情報を短く書きます。
| 書く項目 | 理由 | 例 |
|---|---|---|
| サイトの目的 | 何を壊してはいけないか分かる | 初心者向けのWeb公開トラブル整理サイト |
| 公開方法 | GitHubだけか、FTP/SFTPで本番へ上げるか分かる | 変更後にFTPで公開サーバーへアップロードする |
| 触ってよい範囲 | AIが関係ないファイルまで直す事故を減らせる | 今回の対象ページと関連CSSだけ |
| 触らない範囲 | 秘密情報、DB、決済、管理画面を守れる | .env、DB設定、FTP設定、APIキーは触らない |
| 確認手順 | 修正後に何を見ればよいか迷わない | 構文チェック、ローカル表示、本番URL、スマホ幅を確認 |
この情報は、READMEに詳しく書きすぎる必要はありません。大事なのは、AIが「どこまでやってよいか」を誤解しないように、作業範囲と禁止範囲を先に見える場所へ置くことです。
これだけは押さえたい！READMEの必須項目
良いREADMEには、いくつかの共通した構成要素があります。いきなり書き始めるのが難しい場合は、以下の項目をテンプレートとして意識すると、分かりやすいドキュメントを作成できます。
- プロジェクトタイトルと概要: プロジェクト名と、何をするものなのかを簡潔に説明します。
- 特徴: このプロジェクトの主な機能や、他のツールとの違いを箇条書きでアピールします。
- デモ: プロジェクトが実際に動いている様子がわかるスクリーンショットやGIFアニメーションを掲載します。
- インストール・使い方: プロジェクトを自分の環境で動かすための具体的な手順を説明します。
- ライセンス: このプロジェクトがどのようなライセンスの下で公開されているかを示します。
- 貢献方法: (オープンソースの場合) 他の開発者がどのようにバグ報告や機能追加の提案をすればよいかを案内します。
Markdownの基本構文と書き方【コピペOK】
README.mdはMarkdownという記法で記述します。HTMLのように複雑なタグを覚える必要はなく、簡単な記号で文章をきれいに装飾できます。ここでは、よく使う基本構文をいくつか紹介します。
見出し (Headings)
行頭に`#`を付けることで、見出しを作成できます。`#`の数が多いほど、見出しのレベルは小さくなります。
# 見出しレベル1 (h1)
## 見出しレベル2 (h2)
### 見出しレベル3 (h3)テキストの装飾 (Text Decoration)
文字を強調したり、打ち消し線を引いたりできます。
**これは太字になります***これは斜体になります*~~これは打ち消し線になります~~リスト (Lists)
箇条書きリストは、行頭に`-`や`*`を付けます。番号付きリストは、数字とドットで記述します。
- りんご
- みかん
- ばなな1. 最初にこれを実行
2. 次にこれを実行
3. 最後にこれを実行リンク (Links)
`[表示テキスト](URL)`の形式でリンクを埋め込めます。
[Copicodeのサイトはこちら](https://copicode.com/)画像 (Images)
リンクの先頭に`!`を付けると、画像を埋め込むことができます。
コードブロック (Code Blocks)
コードの断片をきれいに表示するには、バッククォート3つ（```）で囲みます。言語名を指定すると、色付け（シンタックスハイライト）が適用されます。
```javascript
console.log('Hello, Markdown!');
```実践！すぐに使えるREADME.mdテンプレート
これらの構文を使って、汎用的なREADMEのテンプレートを作成しました。これをコピーして自分のプロジェクトに合わせて書き換えれば、誰でも簡単に見栄えの良いREADMEが作成できます。
# プロジェクトタイトル
ここにプロジェクトのキャッチーな説明を1〜2行で記述します。デプロイ先のURLなども記載すると親切です。
## ✨ 主な機能
このプロジェクトのすごいところを3つほどアピールしましょう。
- **機能1:** 〇〇ができます。
- **機能2:** ××という問題を解決します。
- **機能3:** △△な人におすすめです。
## 🚀 使い方・インストール方法
プロジェクトをローカル環境で動かすための手順を記載します。
1. まず、このリポジトリをクローンします。
```shell
git clone https://github.com/あなたのユーザー名/あなたのリポジトリ名.git
```
2. フォルダに移動し、依存関係をインストールします。
```shell
cd あなたのリポジトリ名
npm install
```
3. 以下のコマンドで開発サーバーを起動します。
```shell
npm run dev
```
## 🛠️ 使用技術
このプロジェクトで使用している技術スタックを記載します。
- HTML, CSS, JavaScript
- React
- Vite
- ...
## 📜 ライセンス
このプロジェクトは[MIT License](LICENSE)の下で公開されています。
既存サイト向けREADMEテンプレート
ロリポップやFTPで公開している小さなWebサイトなら、一般的なOSS向けREADMEより、運用と安全確認が分かるテンプレートの方が役立ちます。
# サイト名
このリポジトリは、〇〇向けWebサイトのソース管理用です。
## サイトの目的
- 誰向けのサイトか:
- 何を解決するサイトか:
- 重要な公開URL:
## 公開方法
- ローカルで編集する
- 変更ファイルを確認する
- 必要なファイルだけ本番へアップロードする
- 公開URLで表示を確認する
## AIやCodexに頼んでよい作業
- 文章の整理
- HTML/CSSの小さな修正
- PHP構文エラーの原因調査
- 内部リンクや見出しの改善案
## AIやCodexに任せない作業
- DB削除、初期化、全件更新
- FTP、DB、APIキーなど秘密情報の表示や共有
- 本番ファイルの一括削除
- .htaccessの全文差し替え
- 決済、メール送信、個人情報を含む処理の自動実行
## 修正後の確認
- 変更ファイルを確認する
- PHP構文チェックを行う
- ローカル表示を確認する
- 本番URLを確認する
- 悪化した時に戻すファイルを確認するこのテンプレートは、READMEをそのまま外部公開する前提ではなく、自分とAIが作業範囲を誤解しないための整理メモとして使います。秘密情報や実際の認証情報は書かないでください。
FTP公開サイトのREADMEに書くと便利なこと
READMEは他人向けだけでなく、未来の自分への作業メモにもなります。ロリポップへFTPアップロードしているサイトなら、次のような「秘密ではない運用情報」を書いておくと迷いません。
## 公開作業メモ
- ローカル作業フォルダ: 自分のPC内の作業用フォルダ
- 本番公開フォルダ: サーバー側の公開用フォルダ名だけをメモ
- アップロード対象: 変更したPHP/CSS/画像のみ
- 確認: 構文チェックのあと本番URLを確認FTPホスト名、ユーザー名、パスワード、DB名、管理画面パスワードはREADMEに書きません。Privateリポジトリでも、秘密情報は別管理にしておくほうが安全です。
READMEに入れないものチェック
- FTP接続パスワード
- ロリポップの管理画面ログイン情報
- DB接続ユーザー名とパスワード
- APIキー、Cookie、セッション情報
- 公開前の一時URLや管理用URLの詳細
AIやCodexへ相談する時のREADMEメモ
READMEを整えたら、AIへ丸ごと投げる前に、今回の相談範囲だけを短く抜き出します。リポジトリ全体を見せる時でも、秘密情報や本番認証情報は含めません。
README.mdをもとに、既存サイトの修正を相談します。
サイトの目的:
今回直したいこと:
触ってよいファイル:
触らないファイル:
公開方法:
修正後に確認するURL:
秘密情報は貼っていません。
DB、FTP、APIキー、管理画面、決済、メール送信に関わる変更は、実行前に止まって確認してください。