AI README Generator — AI 自动生成README文件工具

AI README 生成器 使用此技能扫描现有代码项目并为 AI 代理和开发人员生成可维护的文档。生成的文档应帮助未来的 AI 编码会话快速了解： 项目的功能 代码的组织结构 如何运行、测试和构建项目 关键的技术流程 仍需要人类输入的业务知识 默认输出 在目标项目中生成或更新以下文件： AGENTS.md .cursor/rules/ai-readme/RULE.mdc .cursor/rules/ai-readme/generated/project-structure.mdc .cursor/rules/ai-readme/generated/technical-architecture.mdc .cursor/rules/ai-readme/generated/development-guide.mdc .cursor/rules/ai-readme/generated/core-flows.mdc .cursor/rules/ai-readme/manual/business-knowledge.mdc .cursor/rules/ai-readme/manual/lessons-learned.mdc 使用英文文件名以获得更好的跨平台兼容性。当项目语言为中文时，允许使用中文文本。 安全规则 不要创造 API、命令、路径、服务或业务规则。如果不确定，写入 。 不要覆盖 .cursor/rules/ai-readme/manual/ 目录下的现有文件。如果 AGENTS.md 已经存在，先读取它。保留有用的人类编写的约束，并仅更新可以从代码中验证的项目事实。.cursor/rules/ai-readme/generated/ 目录下的生成文件可以从代码证据中刷新。避免泄露机密信息。不要将 .env、凭据、令牌、私钥或本地机器特定的路径复制到生成的文档中。更喜欢简洁、事实性的文档而不是长篇大论。每个 .mdc 文件必须包含带有描述和 alwaysApply: false 的前置内容。每个生成的技术 .mdc 文件应包含至少一个 Mermaid 或 ASCII 图表（如果有用）。 工作流程

• 确定目标项目

如果用户提供路径，使用它。否则检查当前工作空间，并仅在项目根目录模糊时询问。通过检查常见文件来确认项目根目录： JavaScript/TypeScript：package.json、pnpm-lock.yaml、yarn.lock Java：pom.xml、build.gradle、settings.gradle Python：pyproject.toml、requirements.txt、setup.py Go：go.mod Rust：Cargo.toml .NET：.csproj、.sln

• 扫描代码证据

仅读取足够的文件以了解项目： 依赖项/构建文件 README 或现有文档 顶级目录树 主入口点 3-8 个代表性的源文件 测试、配置和脚本（如果可用） 在写入文档之前，记录带有源路径的事实。

• 计划生成文件

对于非平凡项目，保留一个简短的任务计划： 创建/更新 RULE.mdc 结构 写入 project-structure.mdc 写入 technical-architecture.mdc 写入 development-guide.mdc 写入 core-flows.mdc 创建缺失的手动模板 仅创建/更新 AGENTS.md 验证生成的路径并总结 TODO

• 编写文件

根据需要创建目录。使用以下模板，适应内容以验证项目事实。 模板 RULE.mdc

---

description: "AI README 入口点 - 项目规则导航。在开始项目之前请阅读此内容。" alwaysApply: false

---

# AI README - 项目规则入口

项目概述

``mermaid 流程图 LR Entry[入口点] --> Core[核心模块] Core --> Data[数据/外部服务] 生成信息 生成于： 项目根目录： 证据范围： 导航 生成的技术文档 项目结构 - 目录、模块和职责 技术架构 - 层、依赖项和技术栈 开发指南 - 设置、运行、构建、测试和配置 核心流程 - 重要的运行时或业务调用链 人类维护的文档 业务知识 - 域术语、业务规则、产品背景 经验教训 - 陷阱、决定和团队经验

生成的/project-structure.mdc

`md

---

description: "项目结构 - 目录、模块和职责。用于理解代码组织。" alwaysApply: false

---

# 项目结构

目录树

`text 项目根目录/ ├── ... 模块职责 路径 职责 关键文件 模块之间的依赖关系 流程图 LR A[模块 A] --> B[模块 B] 证据 路径/文件

生成的/technical-architecture.mdc

`md

---

description: "技术架构 - 层、依赖项和技术栈。用于理解技术设计。" alwaysApply: false

---

# 技术架构

架构概述

``mermaid 流程图 TD UI[接口/ API 层] --> App[应用/服务层] App --> Domain[域/核心逻辑] Domain --> Infra[基础设施/数据层] 层 职责 主要文件/类 技术栈 类别 技术 版本/来源 目的 语言/运行时 框架 构建工具 测试框架 证据 路径/文件