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，确保与开发工作流无缝衔接。