这个项目能做什么
# improve — 用强模型审计,用廉价模型执行
`improve` 是一种代理技能(Agent Skills 格式),用于审计任何代码库并为其他代理编写实施计划。其核心理念是:将最强大的模型投入到智能积累的部分——理解代码库、判断值得做什么、编写规格——然后将执行交给更便宜的模型。该技能本身从不实现任何内容;计划即是产品。
```
你 → /improve (昂贵模型,提供建议)
plans/ → 001-fix-n-plus-one.md (自包含规格)
其他代理 → 实现、测试、发布 (廉价模型,执行)
```
## 安装
```bash
npx skills add shadcn/improve
```
它适用于任何支持 Agent Skills 格式的代理。计划是纯 Markdown,因此任何代理或人类都可以接手。
## 命令
- `/improve` — 完整审计 → 优先发现 → 计划
- `/improve quick` — 低成本通过:仅热点和主要发现
- `/improve deep` — 详尽:每个包、每个类别
- `/improve security` — 重点审计(也支持性能、测试、错误等)
- `/improve branch` — 仅审计当前分支更改的内容
- `/improve next` — 功能建议,项目未来方向
- `/improve plan <描述>` — 跳过审计,仅规格化一项
- `/improve review-plan <文件>` — 批评并收紧现有计划
- `/improve execute <计划>` — 派遣更便宜的执行器,审查其工作
- `/improve reconcile` — 刷新积压:验证、解除阻塞、淘汰
- `--issues` — 同时将计划发布为 GitHub 问题
## 典型首次运行
1. 在仓库中打开代理并运行 `/improve`(或使用 `/improve quick` 保持低成本)。
2. 它映射仓库、审计并返回发现表。回复您想要计划的项,例如“计划 1、3 和 5”。
3. 计划落在 `plans/` 中——每个文件一个,外加带推荐顺序的索引。它们旨在供审查。
4. 将计划交给任何代理(“实现 plans/001-*.md”),或让技能运行它:`/improve execute 001` 在隔离的工作树中派遣更便宜的模型,根据计划审查差异,并报告裁决。合并仍由您决定。
5. 下次会话,`/improve reconcile` 清理积压:验证已落地的内容,刷新漂移的内容,解除卡住的内容。
在 PR 之前,`/improve branch` 将相同流程范围限定为仅分支更改的内容。
## 工作原理
- **侦察。** 映射仓库:技术栈、约定以及确切的构建/测试/检查命令,这些成为每个计划中的验证门。它还摄取意图和设计文档(如 ADR(`docs/adr/`)、PRD、`CONTEXT.md`、`DESIGN.md`、`PRODUCT.md`),以便已决定的权衡不被重新标记,方向建议保持基于声明的产品意图,计划使用仓库自身的词汇。
- **审计。** 跨九个类别并行派遣子代理:正确性、安全性、性能、测试覆盖、技术债务、依赖与迁移、开发者体验、文档和方向(功能建议必须引用仓库自身的证据)。每个发现都带有 `file:line` 证据、影响、工作量和置信度。
- **审查。** 因为子代理报告过多,顾问在显示任何内容前重新阅读每个引用的位置;丢弃误报,纠正错误归属,记录拒绝。
- **优先排序。** 发现按杠杆(影响 ÷ 工作量,按置信度加权)排序在表中。您选择哪些成为计划。
- **计划。** 每个选定发现在 `plans/` 中一个文件,带索引、优先级顺序和依赖图。
## 使计划可执行的因素
计划针对最弱的合理执行者——一个从未见过顾问会话且可能小得多的模型。三个属性支撑了这一点:
- **自包含。** 所有上下文都内联:确切文件路径、当前状态代码摘录、带示例文件的仓库约定、已验证命令。没有“如上所述”。
- **验证门。** 每一步以命令及其预期输出结束;完成标准是可机器检查的,因此执行者无需判断成功。
- **硬边界。** 明确的超范围列表和停止条件(“如果 X,停止并报告”),而不是让小模型在现实与计划不符时即兴发挥。
每个计划都标记其编写时对应的 git 提交,以便执行者在接触任何内容前运行机械漂移检查。
## 闭环
- **`execute <计划>`** 在隔离的 git 工作树中生成一个更便宜的执行者子代理,将计划交给它,然后像技术负责人一样审查结果——重新运行每个完成标准,检查范围合规性,根据意图阅读差异。裁决:批准(合并由您决定)、退回修订(最多 2 轮)或阻止并细化计划。
- **`reconcile`** 处理自上次以来的情况:验证 DONE 计划是否仍然成立,调查 BLOCKED 计划并围绕障碍重写,刷新漂移的计划,淘汰独立修复的发现。
- **`--issues`** 将计划发布为 GitHub 问题,正文自包含,以便任何代理或人类在已有工作的地方接手。
## 硬性规则
- 从不修改源代码本身。唯一写入是 `plans/`;执行者仅在一次性工作树中编辑,合并始终由您决定。
- 从不运行改变工作树的命令——仅读取、搜索和只读分析。
- 从不复现秘密值;仅位置和凭据类型,始终建议轮换。
- 被要求实现时,拒绝并指向计划(或提供 `execute`)。
## 许可证
MIT © shadcn
评论
0 评分人数达到10人后显示
登录后参与讨论。