执行步骤（共 8 步）

1. 1

   1. 项目架构文档生成复制本步到 IDE

   ## 1. 项目架构文档生成 # Rust 项目架构文档生成器 你是 Rust 项目的文档架构师。目标不是写冗长设计文档，而是让 AI 协作者**快速理解仓库结构、分层边界和常用命令**，需要时再按需深入。 请分析以下项目并输出架构说明： **项目名**：{{project_name}} **一句话描述**：{{one_liner}} **仓库根路径**：{{repo_root}} **主要场景**：{{main_scenario}}（例如：Web API / CLI / 库 / 全栈 SSR） **团队规模**：{{team_size}} **当前文档状态**：{{doc_status}} --- ## 第一步：仓库扫描 请先阅读（或请用户提供）以下内容，再下结论： 1. 根目录 `Cargo.toml` / workspace 成员 2. `src/` 或 `crates/` 下各 crate 的 `lib.rs` / `main.rs` 入口 3. 现有 `README.md`、`AGENTS.md`、`.cursor/rules/` 或同类 AI 入口文件 4. `migrations/`、`scripts/`、`infra/` 等运维相关目录（若有） 输出 **crate 清单表**： | crate / 包 | 职责（一句话） | 对外暴露 | 依赖方向 | | ---------- | -------------- | -------- | -------- | | … | … | bin/lib | 仅依赖下层 | 标注：**禁止的依赖方向**（例如 domain 不得依赖 web）。 --- ## 第二步：分层与数据流 用 ASCII 图描述请求/数据主路径（按项目类型选一种或组合）： ``` HTTP/MCP 请求 → api / server 层（路由、鉴权） → domain 层（业务规则） → db / search / cache 层（持久化与检索） → 返回响应 ``` 补充： | 问题 | 你的结论 | | ---- | -------- | | 单进程还是多服务？ | … | | 数据库 / 搜索 / 缓存各用什么？ | … | | 后台任务 / Worker 是否存在？ | … | | 配置从哪加载（env / 文件）？ | … | --- ## 第三步：开发者速查 输出 **高频命令表**（根据项目实际脚本填写，勿编造）： | 目的 | 命令 | | ---- | ---- | | 本地启动 | … | | 快速编译检查 | … | | 格式化 / lint | … | | 单测 | … | | 迁移 / seed | … | 列出 **5～8 条硬约束**（从现有规则或代码惯例归纳，例如：workspace check 不可只 check 单 crate、禁止某类依赖方向）。 --- ## 第四步：推荐文档树 输出适合该 Rust 项目的文档结构（文件名可适配，原则须满足）： ``` 入口层（AI 首次读，≤80 行） ├── AGENTS.md 或 QUICKREF.md — 会话焦点 + 硬规则 + 文档索引 └── docs/STATUS.md — 当前焦点（一项） 参考层（按需加载） ├── 架构 / 分层说明（本文档可归档于此） ├── 编码规范 / RUST-GUIDE ├── 本地启动与测试 ├── 部署与运维 ├── DECISIONS / ADR └── PITFALLS / 踩坑库 ``` 指出：现有文档中**重复、过时、缺失**的项各 1～3 条。 --- ## 输出格式 1. **架构总览**（crate 表 + ASCII 数据流） 2. **硬约束清单**（编号列表） 3. **场景→文档映射表**（「我要做 X → 看 Y」） 4. **建议新建或合并的文档**（每项一句话理由） 5. **一键续作**（供用户复制给下一个 AI）： ``` 已生成 Rust 项目架构摘要。请读 QUICKREF/AGENTS 与 STATUS， 当前焦点是 [用户填写]。最小 scope 继续，禁止跨 crate 无关重构。 ``` --- ## 硬性约束 - 不编造 crate 名、命令、依赖；信息不足处写「数据待补充」 - 全文中文，表格优先于长段落 - 不为少于 2 个 crate 的仓库设计过度分层

   # Rust 项目架构文档生成器 你是 Rust 项目的文档架构师。目标不是写冗长设计文档，而是让 AI 协作者**快速理解仓库结构、分层边界和常用命令**，需要时再按需深入。 请分析以下项目并输出架构说明： **项目名**：{{project_name}} **一句话描述**：{{one_liner}} **仓库根路径**：{{repo_root}} **主要场景**：{…
2. 2

   2. 编码规范注入复制本步到 IDE

   ## 2. 编码规范注入 # Rust 编码规范注入 你是 Rust 代码规范顾问。请基于项目**已有代码与文档**，提炼一份「AI 写代码时必须遵守」的规范摘要，并给出可粘贴到 IDE 规则文件的片段。 **项目名**：{{project_name}} **Rust 版本 / edition**：{{rust_edition}} **主要框架**：{{frameworks}}（例如：axum、leptos、tokio） **规范参考文件**（若有）：{{existing_guides}} --- ## 第一步：采样 请阅读（或请用户指定）以下位置的**真实代码**（各 1～2 个文件即可）： - `crates/*/src/` 中典型 handler / service / repo - 错误类型定义（`AppError` 或等价物） - 测试文件示例 - 现有 `RUST-GUIDE` / `STANDARDS.md` / `.cursor/rules/` 片段 归纳（每项 3～5 条，附**仓库内真实示例路径**）： | 维度 | 观察到的惯例 | | ---- | ------------ | | 模块与命名 | … | | 错误处理 | … | | async / 并发 | … | | 日志与 tracing | … | | 测试风格 | … | | 格式化与 lint | … | --- ## 第二步：规范正文 输出 **《{{project_name}} Rust 编码规范（AI 版）》**，结构如下： ### 1. 必须遵守 - 匹配现有命名与模块布局；新代码应像同一作者写的 - 错误：使用项目统一错误类型，禁止裸 `unwrap()` 于生产路径（说明项目例外） - 改动范围：最小 diff，禁止顺手重构无关代码 - 编译：说明项目要求的 check 命令（workspace 级或单 crate） ### 2. 禁止项 - 列出项目已拍板的禁止（例如：某依赖源、某部署方式、跨层引用） - 信息不足写「待项目补充」 ### 3. 常用模式 用短代码块展示项目中**推荐**的 2～3 种模式（Handler 签名、Repo 查询、Domain 服务方法等），从真实文件改写，勿 invent API。 ### 4. 注释原则 - 只注释非显而易见的业务规则 - 禁止注释显而易见的行为 --- ## 第三步：IDE 规则片段 输出两段可直接粘贴的内容： **A. Cursor `.mdc` 或 rules 摘要**（≤60 行） **B. 用户消息模板**（会话开始时粘贴）： ``` 本仓库 Rust 规范见 [路径]。请先读 STATUS 当前焦点， 改动遵循最小 scope，改 .rs 后运行 [check 命令]。 ``` --- ## 第四步：验证清单 | 检查项 | 通过标准 | | ------ | -------- | | 规范与采样代码一致 | 无与仓库矛盾的 invented 规则 | | 可执行 | check/fmt 命令来自真实脚本 | | 可维护 | 建议规范文档存放路径 | 结尾附 **一键续作**： ``` 编码规范摘要已对齐。下一任务：[具体功能]， 请按上述规范实现，改完跑 [check 命令]。 ``` --- ## 硬性约束 - 不照搬通用 Rust 风格指南替代项目既有惯例 - 无采样依据的规则标「建议确认」 - 全文中文

   # Rust 编码规范注入 你是 Rust 代码规范顾问。请基于项目**已有代码与文档**，提炼一份「AI 写代码时必须遵守」的规范摘要，并给出可粘贴到 IDE 规则文件的片段。 **项目名**：{{project_name}} **Rust 版本 / edition**：{{rust_edition}} **主要框架**：{{frameworks}}（例如：axum、leptos…
3. 3

   3. PR Review Checklist

   开通会员，解锁全部 8 步。

   开通会员解锁
4. 4

   4. 依赖审计

   开通会员后可查看本步全文

5. 5

   5. 错误排查向导

   开通会员后可查看本步全文

6. 6

   6. 测试用例生成

   开通会员后可查看本步全文

7. 7

   7. 部署检查清单

   开通会员后可查看本步全文

8. 8

   8. 变更日志生成

   开通会员后可查看本步全文