opence
v0.19.5
Published
Compound engineering workflow for AI-assisted development
Maintainers
Readme
opence
面向 AI 协作开发的复合式工程流程(Plan / Work / Review / Compound / Archive)。
opence 不是“命令集合”,而是一套可落地的工作流:先把变化写清楚,再编码;把评审变成明确的风险清单;最后把经验沉淀成可复用的规范和技能。
工作流理念
- 规格是事实:
specs/描述已经上线的系统行为。 - 变更是提案:
changes/记录即将发生的改动与理由。 - 计划驱动实现:代码是对
tasks.md的逐条兑现。 - 评审优先风险:先找缺陷与回归,再谈风格。
- 复利积累:把学到的东西写进
docs/solutions/和技能。
五阶段流程
Plan
目的:把“要做什么、为什么做、影响范围”写成可审阅的计划。
输出产物:
proposal.md:变更目的与影响tasks.md:可执行的实现清单design.md:必要时的技术决策(可选)specs/<capability>/spec.md:变更的规格增量
Work
目的:按任务清单实现,持续同步状态。
输出产物:
- 代码变更
tasks.md进度更新(完成项勾选)
Review
目的:发现缺陷、风险、测试缺口,并按严重性排序。
输出产物:
- 带文件路径的审查清单
- 未覆盖场景与测试建议
Compound
目的:沉淀经验,形成可复用的团队记忆。
输出产物:
docs/solutions/中的问题与解决记录- 必要时新增/更新技能
Archive
目的:将已完成的变更归档,把规格增量合并到主规格中。
输出产物:
changes/archive/<change-id>/归档的变更- 更新后的
specs/主规格文件
目录结构与文件含义
opence/
├── project.md # 项目约定与团队规则
├── AGENTS.md # AI 助手运行规则入口
├── specs/ # 现状规范:系统“已经是什么”
│ └── [capability]/
│ ├── spec.md # 需求与场景(规格真相)
│ └── design.md # 技术模式与约定(可选)
└── changes/ # 变更提案:系统“将要是什么”
├── [change-id]/
│ ├── proposal.md # 为什么改、改什么、影响面
│ ├── tasks.md # 实施清单(必须可执行)
│ ├── design.md # 技术决策(可选)
│ └── specs/
│ └── [capability]/
│ └── spec.md # ADDED/MODIFIED/REMOVED 规格增量
└── archive/ # 已完成并归档的变更规格与变更的关系
specs/是现状真相,任何实现都以此为准。changes/是未来提案,只有被批准并归档后,才会反映回specs/。- 规格增量采用
ADDED / MODIFIED / REMOVED / RENAMED结构。 - 每条需求至少包含一个
#### Scenario:,让验收与测试具象化。
技能与工具集成
opence 会为不同 AI 工具生成一致的技能入口:
.claude/skills/opence-*/SKILL.md(Claude Code、OpenCode、Copilot).codex/skills/opence-*/SKILL.md(Codex).opencode/commands/opence/(OpenCode 原生命令)
这些技能确保各工具执行同一套 Plan/Work/Review/Compound/Archive 流程。
快速上手(最少命令)
npm install -g opence@latest
opence init之后主要在 opence/ 目录内工作;更详细的命令和选项可在 CLI 帮助中查看。
适用工具
- Claude Code
- OpenCode
- Codex
- GitHub Copilot
- 兼容 AGENTS.md 的工具
示例
完整的 Plan/Work/Review/Compound/Archive 示例见 docs/examples/opence-change/。
