寫程式的時候，最懶得做的一件事是什麼？
寫 README.md。

今天我們就來做一個能幫我們自動生成 README 的小工具！
它會自動讀取專案內的 .py 檔,把每個檔案的功能整理成重點 幫你產出一份漂亮的 README.md

from openai import OpenAI
import os, glob

client = OpenAI()

def generate_readme(project_path: str):
    """讀取 Python 專案並產生 README"""
    files = glob.glob(os.path.join(project_path, "*.py"))
    content = ""

    for f in files:
        with open(f, "r", encoding="utf-8") as fp:
            code = fp.read()
        content += f"\n=== {os.path.basename(f)} ===\n{code}\n"

    prompt = f"""
    你是一位專業開發文件編寫員。
    根據以下 Python 專案程式碼內容，幫我生成一份 README.md，
    內容包含：
    1. 專案簡介
    2. 功能說明
    3. 使用方式（假設使用者是一般工程師）
    4. 主要檔案說明

    以下是專案內容：
    {content}
    """

    resp = client.chat.completions.create(
        model="gpt-4o-mini",
        messages=[{"role": "user", "content": prompt}],
    )

    readme_text = resp.choices[0].message.content
    output_path = os.path.join(project_path, "README_AI.md")
    with open(output_path, "w", encoding="utf-8") as f:
        f.write(readme_text)

    print(f"已自動產生 README: {output_path}")

if __name__ == "__main__":
    project_path = input("請輸入專案資料夾路徑: ").strip()
    generate_readme(project_path)

我們拿之前解釋圖片的程式給AI,看看AI會幫我們寫出什麼樣的README


如果想要自動幫每個函式加註解，也可以修改一下prompt的部分就好
今天我們讓 AI幫我們自動產生 README 文件，這對開發者很實用，尤其是在多人專案或教學 Demo 時
AI 不只是幫你寫程式，它也能幫你「整理」程式，這就是 AI 工具真正能節省時間的地方