Skip to content

Commit 7c4acc1

Browse files
Refine bilingual repository landing pages
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
1 parent ee7984e commit 7c4acc1

2 files changed

Lines changed: 151 additions & 73 deletions

File tree

README.md

Lines changed: 75 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# opencode-workflow-playbook
44

5-
**An opinionated OpenCode workflow stack for spec-driven delivery, disciplined execution, specialist augmentation, and runtime validation.**
5+
**A structured OpenCode workflow for turning ideas into tracked execution without losing routing clarity.**
66

77
[简体中文](./README.zh-CN.md) · [Architecture](./docs/en/architecture.md) · [Setup](./docs/en/setup.md) · [Example Prompts](./examples/prompts.en.md)
88

@@ -18,16 +18,19 @@
1818
1919
> **Status:** private-first working draft. The structure is stable enough to share internally now and is being shaped for a later public open-source release.
2020
21+
> [!IMPORTANT]
22+
> One primary owner per task. Other layers may assist, but they do not compete for ownership.
23+
2124
---
2225

2326
## Start here
2427

25-
If you are reading this repo for the first time, use this order:
28+
Choose the path that matches what you need:
2629

27-
1. Read [Workflow stack](#workflow-stack) for the mental model
28-
2. Read [Operating model](#operating-model) to understand ownership and overlays
29-
3. Read [`docs/en/setup.md`](./docs/en/setup.md) if you want to reproduce the setup
30-
4. Read [`examples/prompts.en.md`](./examples/prompts.en.md) for practical usage patterns
30+
- **Understand the model**[Workflow stack](#workflow-stack) and [Operating model](#operating-model)
31+
- **Reproduce the setup**[`docs/en/setup.md`](./docs/en/setup.md)
32+
- **Learn the terminology**[`docs/en/glossary.md`](./docs/en/glossary.md)
33+
- **Adapt the prompts**[`examples/prompts.en.md`](./examples/prompts.en.md)
3134

3235
## Why this repo
3336

@@ -38,6 +41,12 @@ Most AI coding setups fail in one of two ways:
3841

3942
This repository documents a workflow stack designed to avoid both failure modes.
4043

44+
It is for people who already use AI coding tools and want:
45+
46+
- a clear lifecycle owner for tracked work
47+
- stronger execution discipline without duplicate process
48+
- runtime validation when local confidence is not enough
49+
4150
It captures a converged OpenCode setup where:
4251

4352
- **OpenSpec** owns tracked lifecycle work through `opsx-*`
@@ -68,6 +77,9 @@ It captures a converged OpenCode setup where:
6877

6978
## Quick start
7079

80+
> [!TIP]
81+
> Most teams should start with two layers, not five: OmO for orchestration, plus OpenSpec for tracked lifecycle work.
82+
7183
### 1. Understand the model
7284

7385
Read these first:
@@ -92,6 +104,8 @@ The core rule of this stack is simple:
92104
93105
## Operating model
94106

107+
At runtime, the workflow stays simple: pick one owner first, then add overlays only when they contribute a different kind of value.
108+
95109
```text
96110
user request
97111
@@ -145,47 +159,31 @@ The core rule of this stack is simple:
145159
3. Pull in the relevant Gentleman skill for framework-specific quality
146160
4. Use Sentry MCP when runtime evidence matters
147161

148-
## Repository map
149-
150-
```text
151-
.
152-
├── README.md
153-
├── README.zh-CN.md
154-
├── config/
155-
│ ├── opencode.template.json
156-
│ ├── ROUTING_POLICY.template.md
157-
│ └── ENV_SELF_CHECK_POLICY.template.md
158-
├── docs/
159-
│ ├── en/
160-
│ └── zh-CN/
161-
└── examples/
162-
├── prompts.en.md
163-
└── prompts.zh-CN.md
164-
```
165-
166162
## Adoption paths
167163

168164
You do not need to adopt everything at once.
169165

166+
Most teams should begin with a small, legible stack and only add layers when the pain is real.
167+
170168
### Minimal
171169

172-
- OmO baseline only
170+
- OmO baseline only — good for solo experimentation and lightweight local work
173171

174172
### Structured
175173

176-
- OmO + OpenSpec lifecycle via `opsx-*`
174+
- OmO + OpenSpec lifecycle via `opsx-*` — good for repeatable, tracked execution
177175

178176
### Disciplined
179177

180-
- OmO + OpenSpec + Superpowers
178+
- OmO + OpenSpec + Superpowers — good when quality drift starts becoming expensive
181179

182180
### Specialist-ready
183181

184-
- OmO + OpenSpec + Superpowers + selected Gentleman skills
182+
- OmO + OpenSpec + Superpowers + selected Gentleman skills — good for framework-heavy repositories
185183

186184
### Runtime-aware
187185

188-
- add Sentry MCP when local confidence is not enough
186+
- add Sentry MCP when local confidence is not enough and production evidence should shape decisions
189187

190188
## FAQ
191189

@@ -210,15 +208,56 @@ It detects drift in commands, skills, disabled assets, MCP auth, and duplicate l
210208

211209
</details>
212210

211+
<details>
212+
<summary><strong>Who is this repo for?</strong></summary>
213+
214+
It is for people who already use AI coding tools and want a cleaner ownership model, better execution discipline, and a workflow stack that stays composable instead of collapsing into duplicate process.
215+
216+
</details>
217+
213218
## Documentation
214219

215-
- English architecture: [`docs/en/architecture.md`](./docs/en/architecture.md)
216-
- English setup: [`docs/en/setup.md`](./docs/en/setup.md)
217-
- English context log: [`docs/en/context-2026-03-22.md`](./docs/en/context-2026-03-22.md)
218-
- Chinese architecture: [`docs/zh-CN/architecture.md`](./docs/zh-CN/architecture.md)
219-
- Chinese setup: [`docs/zh-CN/setup.md`](./docs/zh-CN/setup.md)
220-
- Chinese context log: [`docs/zh-CN/context-2026-03-22.md`](./docs/zh-CN/context-2026-03-22.md)
220+
- **Read in English**
221+
- [Architecture](./docs/en/architecture.md)
222+
- [Setup](./docs/en/setup.md)
223+
- [Glossary](./docs/en/glossary.md)
224+
- [Config overview](./docs/en/config-overview.md)
225+
- [Context log](./docs/en/context-2026-03-22.md)
226+
- **Read in Chinese**
227+
- [架构说明](./docs/zh-CN/architecture.md)
228+
- [安装说明](./docs/zh-CN/setup.md)
229+
- [术语表](./docs/zh-CN/glossary.md)
230+
- [配置总览](./docs/zh-CN/config-overview.md)
231+
- [上下文记录](./docs/zh-CN/context-2026-03-22.md)
232+
233+
<details>
234+
<summary><strong>Repository map</strong></summary>
235+
236+
```text
237+
.
238+
├── README.md
239+
├── README.zh-CN.md
240+
├── CHANGELOG.md
241+
├── CONTRIBUTING.md
242+
├── CODE_OF_CONDUCT.md
243+
├── config/
244+
│ ├── opencode.template.json
245+
│ ├── ROUTING_POLICY.template.md
246+
│ └── ENV_SELF_CHECK_POLICY.template.md
247+
├── docs/
248+
│ ├── en/
249+
│ └── zh-CN/
250+
└── examples/
251+
├── prompts.en.md
252+
└── prompts.zh-CN.md
253+
```
254+
255+
</details>
256+
257+
## Contributing
258+
259+
Private-first today, public-friendly by design. See [CONTRIBUTING.md](./CONTRIBUTING.md) for contribution expectations and [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) for collaboration norms.
221260

222261
## License
223262

224-
License selection is intentionally left open until the repository is ready to be published publicly.
263+
License is intentionally undecided while the repository remains in private-first draft mode.

README.zh-CN.md

Lines changed: 76 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# opencode-workflow-playbook
44

5-
**一套偏工程化的 OpenCode 工作流栈,用于规格驱动交付、纪律化执行、专家技能增强与运行时验证**
5+
**一套结构清晰的 OpenCode 工作流,用来把想法稳定地推进成可跟踪执行,而不丢掉路由清晰度**
66

77
[English](./README.md) · [架构说明](./docs/zh-CN/architecture.md) · [安装说明](./docs/zh-CN/setup.md) · [示例提示词](./examples/prompts.zh-CN.md)
88

@@ -18,16 +18,19 @@
1818
1919
> **当前状态:** 这是一个 private-first 的工作草稿版仓库。结构已经稳定到可以内部分享,后续会继续整理成适合公开开源的版本。
2020
21+
> [!IMPORTANT]
22+
> 每个任务只能有一个 primary owner。其他层可以辅助,但不能争抢 ownership。
23+
2124
---
2225

2326
## 从哪里开始看
2427

25-
如果你是第一次打开这个仓库,建议按下面顺序看
28+
如果你是第一次打开这个仓库,可以按目标选择入口
2629

27-
1. 先看 [工作流栈](#工作流栈),理解整套模型
28-
2. 再看 [运行模型](#运行模型),理解 owner 和 overlay 的关系
29-
3. 如果想复现环境,再看 [`docs/zh-CN/setup.md`](./docs/zh-CN/setup.md)
30-
4. 如果想知道怎么实际使用,再看 [`examples/prompts.zh-CN.md`](./examples/prompts.zh-CN.md)
30+
- **想理解模型**[工作流栈](#工作流栈)[工作流运行模型](#工作流运行模型)
31+
- **想复现环境**[`docs/zh-CN/setup.md`](./docs/zh-CN/setup.md)
32+
- **想先懂术语**[`docs/zh-CN/glossary.md`](./docs/zh-CN/glossary.md)
33+
- **想直接看提示词** [`examples/prompts.zh-CN.md`](./examples/prompts.zh-CN.md)
3134

3235
## 为什么做这个仓库
3336

@@ -38,6 +41,12 @@
3841

3942
这个仓库记录的,就是一套为了避开这两个极端而收敛出来的 OpenCode 工作流栈。
4043

44+
它适合已经在用 AI 编码工具、但希望进一步得到这些能力的人:
45+
46+
- tracked work 有明确生命周期 owner
47+
- 执行更有纪律,但不会平白多出第二套流程
48+
- 本地信心不够时,可以接入运行时真实证据
49+
4150
它的关键点是:
4251

4352
- **OpenSpec** 通过 `opsx-*` 拥有 tracked lifecycle
@@ -68,6 +77,9 @@
6877

6978
## 快速开始
7079

80+
> [!TIP]
81+
> 大多数团队不需要一开始就装满整套栈。通常从 OmO + OpenSpec 两层开始,就已经很有价值了。
82+
7183
### 1. 先理解模型
7284

7385
建议先读:
@@ -90,7 +102,9 @@
90102

91103
> 每个任务只允许一个 primary owner,其他层只在确实能提供不同价值时作为 overlay 参与。
92104
93-
## 运行模型
105+
## 工作流运行模型
106+
107+
在运行时,这套工作流的思路很简单:先选 owner,再按需加 overlay。不要一开始就把所有层都压上去。
94108

95109
```text
96110
用户请求
@@ -144,47 +158,31 @@
144158
3. 根据技术栈加载相应 Gentleman skill
145159
4. 在运行时证据重要时接入 Sentry MCP
146160

147-
## 仓库结构
148-
149-
```text
150-
.
151-
├── README.md
152-
├── README.zh-CN.md
153-
├── config/
154-
│ ├── opencode.template.json
155-
│ ├── ROUTING_POLICY.template.md
156-
│ └── ENV_SELF_CHECK_POLICY.template.md
157-
├── docs/
158-
│ ├── en/
159-
│ └── zh-CN/
160-
└── examples/
161-
├── prompts.en.md
162-
└── prompts.zh-CN.md
163-
```
164-
165161
## 采用路径
166162

167163
你不需要一次性把整套全装上。
168164

165+
更实际的做法,是从最少的层数开始,只在痛点真正出现时再加东西。
166+
169167
### 最小化采用
170168

171-
- 只使用 OmO 底座
169+
- 只使用 OmO 底座 —— 适合个人实验和轻量本地任务
172170

173171
### 结构化采用
174172

175-
- OmO + OpenSpec `opsx-*`
173+
- OmO + OpenSpec `opsx-*` —— 适合可重复、可追踪的任务执行
176174

177175
### 强纪律采用
178176

179-
- OmO + OpenSpec + Superpowers
177+
- OmO + OpenSpec + Superpowers —— 适合质量漂移已经开始变贵的场景
180178

181179
### 专家增强采用
182180

183-
- OmO + OpenSpec + Superpowers + 有选择地安装 Gentleman skills
181+
- OmO + OpenSpec + Superpowers + 有选择地安装 Gentleman skills —— 适合框架密集型仓库
184182

185183
### 加入运行时验证
186184

187-
- 当本地验证不够时,再接入 Sentry MCP
185+
- 当本地验证不够时,再接入 Sentry MCP,让生产/运行时证据参与判断
188186

189187
## 常见问题
190188

@@ -209,15 +207,56 @@
209207

210208
</details>
211209

210+
<details>
211+
<summary><strong>这个仓库更适合什么样的人?</strong></summary>
212+
213+
它更适合已经在使用 AI 编码工具,但希望把 ownership、执行纪律和运行时验证整理得更清楚的人,而不是想找一套“装上就自动完美”的神奇框架的人。
214+
215+
</details>
216+
212217
## 文档入口
213218

214-
- 中文架构:[`docs/zh-CN/architecture.md`](./docs/zh-CN/architecture.md)
215-
- 中文安装:[`docs/zh-CN/setup.md`](./docs/zh-CN/setup.md)
216-
- 中文上下文记录:[`docs/zh-CN/context-2026-03-22.md`](./docs/zh-CN/context-2026-03-22.md)
217-
- English architecture: [`docs/en/architecture.md`](./docs/en/architecture.md)
218-
- English setup: [`docs/en/setup.md`](./docs/en/setup.md)
219-
- English context log: [`docs/en/context-2026-03-22.md`](./docs/en/context-2026-03-22.md)
219+
- **中文阅读路径**
220+
- [架构说明](./docs/zh-CN/architecture.md)
221+
- [安装说明](./docs/zh-CN/setup.md)
222+
- [术语表](./docs/zh-CN/glossary.md)
223+
- [配置总览](./docs/zh-CN/config-overview.md)
224+
- [上下文记录](./docs/zh-CN/context-2026-03-22.md)
225+
- **English reading path**
226+
- [Architecture](./docs/en/architecture.md)
227+
- [Setup](./docs/en/setup.md)
228+
- [Glossary](./docs/en/glossary.md)
229+
- [Config overview](./docs/en/config-overview.md)
230+
- [Context log](./docs/en/context-2026-03-22.md)
231+
232+
<details>
233+
<summary><strong>仓库结构</strong></summary>
234+
235+
```text
236+
.
237+
├── README.md
238+
├── README.zh-CN.md
239+
├── CHANGELOG.md
240+
├── CONTRIBUTING.md
241+
├── CODE_OF_CONDUCT.md
242+
├── config/
243+
│ ├── opencode.template.json
244+
│ ├── ROUTING_POLICY.template.md
245+
│ └── ENV_SELF_CHECK_POLICY.template.md
246+
├── docs/
247+
│ ├── en/
248+
│ └── zh-CN/
249+
└── examples/
250+
├── prompts.en.md
251+
└── prompts.zh-CN.md
252+
```
253+
254+
</details>
255+
256+
## 参与与协作
257+
258+
这个仓库目前仍然是 private-first,但已经按公开协作的方向组织。贡献说明见 [CONTRIBUTING.md](./CONTRIBUTING.md),协作行为规范见 [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)
220259

221260
## License
222261

223-
正式开源前,License 暂时留空,等仓库公开阶段再统一决定
262+
在仓库仍处于 private-first 草稿阶段时,License 暂时保持未定

0 commit comments

Comments
 (0)