readme

README Generator - 极其详尽的项目文档生成工具

技能概述

README Generator 是一款专业的项目文档生成技能，能够自动创建极其详尽的 README.md 文件，涵盖本地开发设置、系统架构说明和生产部署指南。

适用场景

创建新项目文档

当你启动新项目或为现有项目补充文档时，该技能能生成包含开发环境配置、技术栈说明、目录结构、数据库设计、环境变量、可用脚本、测试方法和部署步骤的完整文档。

开源项目维护

为开源项目生成专业的说明文档，帮助其他开发者快速理解项目结构、本地搭建开发环境、参与贡献以及正确部署应用。

团队项目交接

在团队内部进行项目交接时，生成详尽的技术文档让新成员快速上手，包含架构设计、数据流、请求生命周期等深层技术细节。

核心功能

智能代码库分析

在生成文档前深入探索项目结构，自动识别框架类型、依赖管理文件、配置文件、数据库架构、部署配置、CI/CD 设置和脚本命令，确保文档内容准确反映项目实际情况。

全面文档结构

生成包含项目概述、技术栈、前置条件、快速开始、架构详解、环境变量、脚本命令、测试指南、部署说明和故障排查的完整文档结构，确保任何开发者都能快速上手。

部署平台适配

自动识别项目使用的部署平台（Docker、Kamal、Fly.io、Heroku、Render、Vercel 等），并生成对应的部署说明，让生产环境部署有章可循。

常见问题

README 文件应该包含哪些内容？

一个完整的项目 README 应包含：项目名称与简介、主要功能、技术栈、前置条件、本地开发步骤、架构说明、环境变量配置、可用脚本命令、测试方法、部署指南和故障排查。对于超过 200 行的长文档，建议添加目录导航。

这款工具支持哪些项目类型？

README Generator 支持多种技术栈的项目识别，包括 Ruby on Rails、Node.js、Python Django/Flask、Go、PHP 等主流框架。它能自动识别项目中的 Gemfile、package.json、requirements.txt、go.mod 等依赖文件，以及 Dockerfile、docker-compose.yml、fly.toml 等部署配置，生成针对性的文档内容。

生成的文档有多详细？

该技能以"极其详尽"为标准，不仅包含基本的安装和运行命令，还会深入讲解请求生命周期、数据流向、组件关系、数据库表结构、环境变量用途、脚本命令说明、测试示例和各种部署平台的具体步骤。假设读者是在全新机器上首次接触项目，提供从零开始的完整指引。