Skip to content

Commit 209380e

Browse files
committed
docs: deepen public task paths and workflows
1 parent 84a80e2 commit 209380e

45 files changed

Lines changed: 1525 additions & 303 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 15 additions & 208 deletions
Original file line numberDiff line numberDiff line change
@@ -30,52 +30,20 @@ devcodex status
3030

3131
“本地优先”表示工作流状态、Profile、报告、记忆和工作区 Skill 以本地文件保存;模型执行和数据处理仍遵循所选 AI Coding 宿主的规则。
3232

33-
## 目录
34-
35-
- [为什么需要 DevCodex?](#为什么需要-devcodex)
36-
- [安装后,你能解决什么?](#安装后你能解决什么)
37-
- [什么时候直接使用宿主,什么时候用 DevCodex?](#什么时候直接使用宿主什么时候用-devcodex)
38-
- [它如何工作?](#它如何工作)
39-
- [5 分钟开始](#5-分钟开始)
40-
- [安装会改变什么](#安装会改变什么)
41-
- [工作流、Skill 与宿主边界](#工作流skill-与宿主边界)
42-
- [常见任务怎么说](#常见任务怎么说)
43-
- [常见问题与排错](#常见问题与排错)
44-
- [更新](#更新)
45-
- [卸载](#卸载)
46-
- [添加自己的 Skill](#添加自己的-skill)
47-
- [边界](#边界)
48-
- [许可证](#许可证)
49-
50-
完整用户文档:[DevCodex Docs](https://devcodex-labs.github.io/devcodex/)。运行机制:[架构](https://devcodex-labs.github.io/devcodex/concepts/architecture)、[工作流](https://devcodex-labs.github.io/devcodex/workflows/)、[续接案例](https://devcodex-labs.github.io/devcodex/examples/resume)。
33+
README 只保留安装、定位和必要边界;完整教程与持续更新的参考以 [DevCodex Docs](https://devcodex-labs.github.io/devcodex/) 为准:
34+
35+
- [5 分钟开始](https://devcodex-labs.github.io/devcodex/guide/getting-started)
36+
- [四个任务教程](https://devcodex-labs.github.io/devcodex/tutorials/ambiguous-request)
37+
- [CLI 命令](https://devcodex-labs.github.io/devcodex/reference/cli)
38+
- [故障排查](https://devcodex-labs.github.io/devcodex/guide/troubleshooting)
39+
- [信任、安全与数据](https://devcodex-labs.github.io/devcodex/guide/trust-security-data)
5140

5241
## 为什么需要 DevCodex?
5342

5443
真实工程任务往往跨文件、跨轮次、跨宿主:新会话缺少项目背景,长任务容易断层,项目规范难复用,验证也容易被一句“完成了”替代。
5544

5645
DevCodex 把意图识别、按需上下文、专业 Skill、确认边界、验证、报告和续接放进同一条流程,让 AI 在明确项目与证据范围内工作。
5746

58-
## DevCodex 解决什么问题?
59-
60-
| 问题 | 处理方式 | 收益 |
61-
|---|---|---|
62-
| 重复解释项目背景 | 按意图读取必要 Profile、记忆与源码 | 更快进入有效状态 |
63-
| 长任务难续接 | 报告和文件记忆记录真实进度 | 新会话可恢复 |
64-
| 多宿主规则分散 | 一个包刷新六宿主适配 | 保留一致工作流习惯 |
65-
| 只有 prompt、没有闭环 | 需求、执行、验证与交付串联 | 减少“假完成” |
66-
| 团队流程难复用 | 项目级工作区 Skill | 跨宿主共享约定 |
67-
68-
## 核心特色
69-
70-
| 特色 | 说明 |
71-
|---|---|
72-
| 六宿主适配 | 支持 Codex、Claude Code、GitHub Copilot、Gemini CLI、Grok 和 Cursor(Beta),同时保留能力差异 |
73-
| 按需上下文 | 只加载当前任务需要的项目资料和专业能力 |
74-
| 文件记忆 | 记录任务进度、验证证据与剩余风险 |
75-
| 80+ 内置专业 Skill | 覆盖开发、修复、审查、测试、发布、文档和平台治理,并按任务渐进加载 |
76-
| 本地优先 | 普通使用不需要额外后台服务 |
77-
| 原生资产共存 | 不接管宿主自己的 Skill、指令或个人配置 |
78-
7947
<!-- devcodex-public:capability-scenarios:start -->
8048
## 安装后,你能解决什么?
8149

@@ -119,75 +87,24 @@ DevCodex 把意图识别、按需上下文、专业 Skill、确认边界、验
11987

12088
## 它如何工作?
12189

122-
```text
123-
用户请求
124-
→ 判断任务意图与项目边界
125-
→ 读取必要上下文和记忆
126-
→ 加载匹配的内置 Skill 或工作区 Skill
127-
→ 执行开发 / 修复 / 分析 / 审计
128-
→ 验证、报告并写入可续接状态
129-
```
130-
131-
逐步说明见站点:[架构](https://devcodex-labs.github.io/devcodex/concepts/architecture)、[意图驱动](https://devcodex-labs.github.io/devcodex/concepts/intent-driven)、[六个主工作流](https://devcodex-labs.github.io/devcodex/workflows/)、[跨会话续接案例](https://devcodex-labs.github.io/devcodex/examples/resume)。旧的[工作流参考页](https://devcodex-labs.github.io/devcodex/reference/workflows)仍然可用。
132-
133-
用户仍然用自然语言提出任务;底层强制能力取决于当前宿主可用的 Hook、MCP、插件和权限。
134-
135-
## 适合谁?
136-
137-
- 同时使用一个或多个受支持 AI Coding 宿主的开发者。
138-
- 经常处理跨文件、跨轮次、需要验证的工程任务的人。
139-
- 希望项目规则、发布流程和团队检查清单可复用的人。
90+
用户请求 → 意图与项目边界 → 有界 Profile/记忆/源码 → 当前阶段 Skill → 只读结论或确认后写入 → 验证、报告与续接。逐步说明见[架构](https://devcodex-labs.github.io/devcodex/concepts/architecture)。
14091

14192
## 5 分钟开始
14293

143-
### 系统要求
144-
145-
- Node.js `>=18.17.0`
146-
- npm
147-
- 至少一个受支持宿主
148-
14994
```bash
150-
node -v
151-
npm -v
15295
npm install -g devcodex
153-
devcodex --version
154-
```
155-
156-
安装前请确认 registry 上的版本;如果 registry 上的版本不是文档对应版本,不要把本地源码版本当作已经发布。
157-
158-
进入项目或多项目 workspace 的真实根目录:
159-
160-
```bash
16196
cd <你的项目根目录>
16297
devcodex init
16398
devcodex status
164-
devcodex doctor
16599
```
166100

167-
`devcodex init` 创建 `.devcodex/` 运行态;安装生命周期中刷新用户级宿主适配,但安装本身不修改业务源码。更新后必须重新打开宿主的新会话,已打开的会话不会中途换版本。
168-
169-
Grok 推荐使用 Grok Full 入口:
170-
171-
```bash
172-
devcodex grok
173-
```
174-
175-
普通 `grok` 是 Partial 兼容入口。Cursor 本地 IDE / CLI 为 Beta;Cursor Cloud Agent 保持 Partial / `UNVERIFIED`。
176-
177-
### 安装后的成功信号
178-
179-
1. `devcodex --version` 能返回版本;
180-
2. `devcodex init` 后项目根出现 `.devcodex/`,且 `devcodex status` 能读取该运行态;
181-
3. 完全重新打开目标项目的宿主会话后,先发送一条“只分析,不修改文件”的任务;
182-
4. 如果适配器未就绪、契约失败或宿主入口不明确,运行 `devcodex doctor`,再按 [故障排查](https://devcodex-labs.github.io/devcodex/guide/troubleshooting) 恢复。
183-
184-
第一个任务可以直接写:
101+
需要 Node.js `>=18.17.0` 和 npm。`devcodex init` 创建 `.devcodex/` 运行态;安装生命周期中刷新用户级宿主适配,但安装本身不修改业务源码。安装或更新后必须重新打开宿主的新会话。第一个任务:
185102

186103
```text
187104
分析当前项目最应该先改进的三个问题。只分析,不修改文件。
188105
```
189106

190-
更多步骤见[快速开始](https://devcodex-labs.github.io/devcodex/guide/getting-started)。
107+
入口、预期结果和失败恢复见[5 分钟开始](https://devcodex-labs.github.io/devcodex/guide/getting-started)。
191108

192109
## 安装会改变什么
193110

@@ -199,44 +116,7 @@ devcodex grok
199116
| 后台服务 | 普通使用不启动常驻网络服务 |
200117
| 宿主原生资产 | 不扫描、复制、合并、覆盖或删除 |
201118

202-
## 项目 Profile
203-
204-
普通单项目只需 `devcodex init`。多项目 workspace 的子项目需要独立 Profile 时,从 workspace 根预览并初始化:
205-
206-
```bash
207-
devcodex init --profile <项目相对路径> --dry-run
208-
devcodex init --profile <项目相对路径>
209-
```
210-
211-
目标必须真实且唯一;预览不写入,正式执行只补缺失基线,不覆盖已编辑内容。详见[配置](https://devcodex-labs.github.io/devcodex/reference/configuration)。
212-
213-
## 首次信任提示
214-
215-
首次打开新会话时,宿主可能要求允许 DevCodex 管理的 Hook、MCP、插件或本地命令。只允许 DevCodex-managed 项;若拒绝,依赖这些能力的流程不会完整。
216-
217-
第一次直接用自然语言即可:
218-
219-
```text
220-
阅读这个仓库,修复当前失败的 GitHub CI,并运行相关测试。
221-
```
222-
223-
### 自动推进:`@devcodex-auto`
224-
225-
正式入口是 `@devcodex-auto`;`@rocky` 是默认兼容快捷别名。自动推进只在明确范围内连续工作,不扩大删除、发布或越过项目范围的权限。
226-
227-
项目配置可以替换默认快捷别名:
228-
229-
```json
230-
{
231-
"extensions": {
232-
"devcodex": {
233-
"autoAliases": ["@team-auto"]
234-
}
235-
}
236-
}
237-
```
238-
239-
`extensions.devcodex.autoAliases` 为非空数组时替换 `@rocky`;省略时保留默认值;空数组 `[]` 关闭默认快捷别名,但不会改名 `@devcodex-auto`。
119+
正式 auto 入口是 `@devcodex-auto`,`@rocky` 是默认快捷别名。`extensions.devcodex.autoAliases` 的非空数组会替换默认别名,空数组 `[]` 会关闭默认别名;auto 不扩大删除或发布权限。多项目与 Profile 设置见[配置](https://devcodex-labs.github.io/devcodex/reference/configuration)。
240120

241121
## 工作流、Skill 与宿主边界
242122

@@ -282,51 +162,16 @@ Rules / `AGENTS.md` 提供约束,Skills 提供专业流程,MCP 提供结构
282162
分析当前架构风险,给出证据和优先级。只分析,不修改文件。
283163
```
284164

285-
```text
286-
为当前 API 增加幂等支持。先整理需求,确认后实施并运行相关测试。
287-
```
288-
289-
```text
290-
复现支付回调重复入账,定位根因,检查同类路径并修复。
291-
```
292-
293-
```text
294-
继续<任务名>任务
295-
```
296-
297-
```text
298-
@devcodex-auto 修复失败的 CI,验证通过后提交。
299-
```
300-
301-
只有明确写出 `push、tag、GitHub Release 和 npm publish`,才把对应发布动作纳入任务范围。更多示例见[常见任务](https://devcodex-labs.github.io/devcodex/guide/common-tasks)。
165+
功能、修复、审查、auto 和续接示例见[常见任务](https://devcodex-labs.github.io/devcodex/guide/common-tasks)与[四个教程](https://devcodex-labs.github.io/devcodex/tutorials/ambiguous-request)。只有明确写出 `push、tag、GitHub Release 和 npm publish`,才把对应发布动作纳入范围。
302166

303167
## 常见问题与排错
304168

305-
### 安装最新版后,为什么没有需求概况、PC0~PC7 或 CP 流程?
306-
307-
在目标项目运行:
308-
309169
```bash
310170
devcodex status
311171
devcodex doctor --json
312-
devcodex global-adapters apply
313172
```
314173

315-
然后完全退出宿主并新建会话。`adapter=not-ready`、`contract=failed` 或 `host kernel not installed` 表示受管入口未就绪;`native=unverified` 只表示缺少原生回放证据,不等于 adapter 失败。
316-
317-
### Grok 能看到 Skill 或 MCP,但没有完整上下文怎么办?
318-
319-
使用 `devcodex grok`。普通 `grok` 是 Partial;catalog 或路由决定不等于正文已加载,`StageLoadReceiptV1` 才是阶段正文成功回执。Grok ParserError、Hook 双来源与恢复步骤见[宿主边界](https://devcodex-labs.github.io/devcodex/reference/hosts)。
320-
321-
### Cursor 已安装 DevCodex,但为什么没有流程或 SkillRoute?
322-
323-
检查 `devcodex doctor --json` 和 `agent --version`。受管 Hook 位于 `~/.cursor/hooks.json`;Cursor Cloud Agent 不加载用户级 Hook,不能继承本地 Beta 结论。命令碰撞与 IDE / CLI / Headless 差异见[宿主边界](https://devcodex-labs.github.io/devcodex/reference/hosts)。
324-
325-
### “帮我审批”时反复重新连接,是否必须开启完全访问?
326-
327-
不需要永久开启 Full access。`node runtime BLOCK` / `sandbox-exec-denied` 表示 Node launcher 被当前沙箱拒绝;`GLOBAL_HOST_TARGET_UNVERIFIED` 表示对应用户级宿主目录当前不可读。先按最小范围批准并重跑 `devcodex doctor`,不要把完全访问当作默认修复。
328-
329-
完整的 adapter、contract、native、sandbox、临时目录与运行态排查见[故障排查](https://devcodex-labs.github.io/devcodex/guide/troubleshooting)和[限制与边界](https://devcodex-labs.github.io/devcodex/reference/limits)。
174+
先区分 workspace、configured、contract 与 native evidence。按 typed issue 修复;`UNVERIFIED` 不等于失败。完整决策树见[故障排查](https://devcodex-labs.github.io/devcodex/guide/troubleshooting)和[状态与错误码](https://devcodex-labs.github.io/devcodex/reference/diagnostics)。
330175

331176
## 更新
332177

@@ -350,52 +195,14 @@ npm uninstall -g devcodex
350195

351196
用户自己的配置、指令和 Hook 会保留;若受管资产被修改或所有权无法验证,清理会失败关闭。不要先卸载 npm 包,否则安全清理命令会先消失。
352197

353-
## 运行态与临时产物检查
354-
355-
```bash
356-
devcodex runtime status
357-
devcodex runtime prune --dry-run
358-
devcodex tmp status --json
359-
devcodex tmp maintain --project=<project> --partition=runs
360-
```
361-
362-
清理类命令默认只预览;实际操作必须显式 `--apply` 和完整 scope。`MemoryCursorV1`、`MemoryFileTransactionReceiptV1`、`WorkspaceTempManifestV2` 与 `NextActionEnvelopeV1` 等高级协议见[限制与边界](https://devcodex-labs.github.io/devcodex/reference/limits)。
363-
364-
## 生效方式
365-
366-
DevCodex 分为用户 HOME 下的宿主适配层与项目 / workspace 的 `.devcodex/` 运行态。内置 Skill 随 npm 包安装;工作区 Skill 由项目提供。
367-
368-
多项目 workspace 的典型结构和恢复路径见[配置](https://devcodex-labs.github.io/devcodex/reference/configuration)与[故障排查](https://devcodex-labs.github.io/devcodex/guide/troubleshooting)。
369-
370-
## 添加自己的 Skill
371-
372-
在项目或 workspace 根创建:
373-
374-
```text
375-
<你的项目根目录>/
376-
.devcodex/
377-
workspace/
378-
skills/
379-
<id>/
380-
SKILL.md
381-
intent.json
382-
```
383-
384-
稳定路径是 `<你的项目根目录>/.devcodex/workspace/skills/<id>/SKILL.md`。`SKILL.md` 写目标、步骤、输入输出和边界;`intent.json` 写可验证的触发语义。完整示例见[Skill 参考](https://devcodex-labs.github.io/devcodex/reference/skills)。
385-
386-
## 与宿主原生 Skill 共存
387-
388-
DevCodex 不扫描、复制、合并、覆盖或删除这些用户资产。Codex、Claude Code 等宿主自己的 Skill、项目指令和个人配置继续按宿主规则生效。
389-
390-
需要六宿主共享时使用 DevCodex 工作区 Skill;只服务单一宿主时继续使用该宿主原生机制。
391-
392198
## 边界
393199

394200
- DevCodex 不替代业务框架、GitHub CI、安全审计或人工评审。
395201
- 宿主能力、权限与生命周期事件不同,不能互相继承验证结论。
396202
- 安装不会把用户级宿主配置写进业务 workspace;项目侧只保存 `.devcodex/` 运行态。
397203
- 工作区 Skill 只影响其所在项目或 workspace。
398-
- 更多限制见[限制与边界](https://devcodex-labs.github.io/devcodex/reference/limits)。
204+
- 模型执行和数据处理仍遵循所选 AI Coding 宿主的规则。
205+
- 更多限制见[限制与边界](https://devcodex-labs.github.io/devcodex/reference/limits)和[信任、安全与数据](https://devcodex-labs.github.io/devcodex/guide/trust-security-data)。
399206

400207
---
401208

‎changelogs/unreleased.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# 未发布变更(Unreleased)
22

33
> **用途**: 记录尚未正式发版的实现级变更。
4-
> **当前**: v1.17.10 已发布并完成 R7。当前没有新的未发布实现候选;后续变更再记入本节。发行事实以 Git tag、npm registry、GitHub Release 与 Profile 05 的 `ProfileCurrentTruthV1` 为准。
4+
> **当前**: v1.17.10 已发布并完成 R7;下列文档站重构为未发布工作树候选,不代表 registry 用户已经获得。发行事实以 Git tag、npm registry、GitHub Release 与 Profile 05 的 `ProfileCurrentTruthV1` 为准。
55
66
## 当前未发布实现候选
77

8+
- **公开站工作流完整分层与语义流程**:公开站从“总览 + 6 个 primary ID”收敛为工作流选择、开发与修复、分析/审查/规划、对话/续接 4 个任务入口;完整解释 8 个 canonical workflow、6 primary + 2 advanced、12 个用户任务 subtype、1 个内部 `dev.plan-review` step 和 7 个 audit target。六个旧 URL 保留,架构与选择流程改为无需图表运行时的语义化响应式列表;控制面仅同步 `other/plan` 与内部步骤术语,runtime/CLI/Hook/MCP 行为和依赖不变。
9+
- **公开用户文档站任务化重构**:公开站从概念摘要扩展为 Journey / Trust / Reference 三层,新增四个任务教程、宿主与 workspace 设置、信任/安全/数据、CLI、状态错误码、运行态维护和术语表;quick start 收敛为单一只读首次成功路径,README 缩短并把深入说明指向 canonical Pages。四张首页能力卡各自进入独立教程;package 版本与生成时间写入 public projection,host reference 与产品表达由测试对账。旧 URL 全部保留,CLI/runtime/adapter 行为和依赖不变。
810
- **公开站点内容与事实生成升级**:在保留已发布 9 个 URL 的前提下增加 concepts / workflows / 一条续接案例;生成器从现有投影器写出 `public-site/data/public-product-projection.json` 并刷新 marker 与 README V2 数字句;页数合同改为必存在路径 + 下限 23。
911
- **需求状态字段回写**:把 v1.17.10 从「发布候选」改为已归档;需求 `00-需求概况.md` / `01-需求确认.md` 头部改为 `released-v1.17.10`。不改 README、package、plugin、homepage 或运行时。
1012

‎content/duplication-inventory.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"schemaVersion": "ControlContentDuplicationInventoryV1",
3-
"sourceBundleDigest": "a397acdbbfa42b961f2ca1f94ede9c210b3ee180426c096268e0d46e95693cc5",
3+
"sourceBundleDigest": "81abbe2cfaa7358a4dca27be7a97ff7970677e844f7d56f21e5f7220632da5c2",
44
"thresholds": {
55
"minParagraphChars": 100,
66
"sectionThreshold": 0.94,

‎content/instructions/10-dev.instructions.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ version: 1.17.10
66
---
77
# 开发工作流规则(10-dev)
88

9-
> 本文件定义 dev 工作流的完整规则,含 8 个子类型和 CP 门控。
9+
> 本文件定义 dev 工作流的完整规则,含 7 个用户任务子类型、1 个内部 `plan-review` 步骤和 CP 门控。
1010
11-
> 子类型标识:`dev.default` / `dev.docs` / `dev.refactor` / `dev.database` / `dev.init` / `dev.optimization` / `dev.scenario-test` / `dev.plan-review`
11+
> 用户任务子类型:`dev.default` / `dev.docs` / `dev.refactor` / `dev.database` / `dev.init` / `dev.optimization` / `dev.scenario-test`
12+
>
13+
> 内部步骤 route key:`dev.plan-review`。它在 CP2 后按规则触发,不参与用户任务子类型选择。
1214
1315
## 子类型路由
1416

@@ -20,10 +22,10 @@ version: 1.17.10
2022
| 性能/optimize/优化指标 | optimization |
2123
| 测试/scenario-test/压测 | scenario-test |
2224
| 文档/docs/README/注释 | docs |
23-
| 方案评审/plan-review/review | plan-review |
2425
| 默认(新功能/需求)| default |
2526

2627
- optimization/scenario-test 前置条件:`api-verification` 已通过,否则阻断并提示
28+
- 用户请求“评审方案”时先按最终目的路由到 `audit` 或 `dev`;`dev.plan-review` 只表示 dev 内部的方案复审步骤。
2729

2830
## C12 合理性评估(必须执行)
2931

@@ -483,6 +485,6 @@ CP1(需求确认)→ PR-1 内部自检 → CP2(方案确认)→ plan-rev
483485
- 当文档任务属于契约驱动型需求时,可先冻结目标文档,再做简化版 CP2 文档大纲确认
484486
- 文档质量标准:结构完整 / 示例可执行 / 版本同步 / 链接有效
485487

486-
### plan-review(方案评审)
488+
### 内部步骤 plan-review(方案评审)
487489
- 豁免 plan-review(防递归)
488490
- 本身即为审查工作流

0 commit comments

Comments
 (0)