readme

README 產生器是一款專業級的技術寫作工具，旨在解決開發者加入新程式碼庫時遇到的「從何開始」難題。它超越了標準模板的限制，提供一份「極致詳盡」的指南，引導使用者從全新環境設定到生產環境維護。該工具會對目標儲存庫進行深入的遞迴分析，檢視目錄結構、設定檔、環境變數、相依套件及部署清單。對於需要確保專案易於接手且文件完善的資深開發者、開源維護者及團隊主管來說，這是理想的解決方案，能免除手動編寫長篇技術文件的繁重工作。

• 自動對應專案結構並識別技術堆疊，包括 Ruby on Rails、Node.js、Docker 以及 Fly.io、Vercel 和 Render 等雲端部署平台。

• 產生涵蓋本地開發流程、架構深度解析（包含資料流與請求生命週期）、環境變數參考及測試程序的完整章節。

• 根據現有基礎設施（如 Dockerfile、資料庫遷移檔或 CI/CD 設定檔）識別部署目標，並編寫客製化的部署指南。

• 提供強大的疑難排解指南，預先應對常見瓶頸，例如資料庫連線問題、資源編譯失敗及相依套件衝突。

• 輸出高品質的 Markdown 文件，包含超連結目錄、可直接複製的 Bash 指令以及標準化的程式碼區塊。

• 可透過「create a readme」、「document this project」或「write a readme for this codebase」等自然語言指令觸發。

• 工具運作於現有專案根目錄，透過解析 Gemfile、package.json、Procfile 或 db/schema.rb 等檔案來建構說明內容。

• 使用者應確保程式碼庫結構清晰，工具會分析設定檔以建立正確的環境變數需求列表。

• 文件直接寫入專案根目錄的 README.md，確保與開發工作流無縫接軌。