📦 SKILL🛠 Dev🔧 Read, Bash, Grep, Write
สร้าง README ให้โปรเจกต์ (จากโค้ดจริง)
สแกนโปรเจกต์แล้วเขียน README.md ครบ install/usage/env/structure จากสิ่งที่อยู่ในโค้ดจริง — ใช้เมื่อจะ push ขึ้น GitHub, ส่งงานลูกค้า, เปิด open-source หรือกลับมาดูโปรเจกต์เก่าแล้วจำไม่ได้ว่ารันยังไง
--- name: readme-generator description: สแกนโปรเจกต์แล้วเขียน README.md ครบ install/usage/env/structure จากสิ่งที่อยู่ในโค้ดจริง — ใช้เมื่อจะ push ขึ้น GitHub, ส่งงานลูกค้า, เปิด open-source หรือกลับมาดูโปรเจกต์เก่าแล้วจำไม่ได้ว่ารันยังไง allowed-tools: Read, Bash, Grep, Write --- # สร้าง README ให้โปรเจกต์ (จากโค้ดจริง) ## Workflow 1. สแกนหา manifest: `package.json` / `requirements.txt` / `pyproject.toml` / `go.mod` / `composer.json` — เพื่อรู้ภาษา, dependency, และ scripts (`dev`/`build`/`start`/`test`) 2. ดูโครงโฟลเดอร์ (`git ls-files` หรือ `ls`) เพื่อเข้าใจสถาปัตยกรรม; เปิด entry point (`index`, `main`, `app`) อ่านว่าโปรเจกต์ทำอะไร 3. หา env vars จริง: grep หา `process.env.` / `os.environ` / `getenv` หรืออ่าน `.env.example` — รวมเป็นตาราง (ห้ามดึงค่าจริงจาก `.env`) 4. หา command รันจริงจาก scripts ใน manifest — ไม่เดา ใช้ที่มีจริง 5. ประกอบ README ตามโครงด้านล่าง ภาษาไทยอ่านง่าย (โค้ด/คำสั่งคงเป็นอังกฤษ) เขียนลง `README.md` 6. ถ้าข้อมูลส่วนไหนไม่พอ (เช่น license, ผู้เขียน) → ใส่ placeholder `<...>` แล้วบอกผู้ใช้ว่าต้องเติมตรงไหน …
ใช้ได้กับ
- เขียนโปรเจกต์เสร็จจะ push ขึ้น GitHub แต่ยังไม่มี README
- ส่งโค้ดให้ลูกค้า/ทีม อยากมีเอกสารบอกวิธีรัน
- กลับมาดูโปรเจกต์เก่าแล้วจำไม่ได้ว่าตั้งค่ายังไง
- อยากให้ repo ดูโปรเก่ง น่าเชื่อถือ มี badge + โครงสร้างชัด