Skip to content

Commit 84a80e2

Browse files
committed
docs: clarify DevCodex public value
1 parent d4d9b1b commit 84a80e2

14 files changed

Lines changed: 703 additions & 14 deletions

README.md

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ devcodex status
3333
## 目录
3434

3535
- [为什么需要 DevCodex?](#为什么需要-devcodex)
36+
- [安装后,你能解决什么?](#安装后你能解决什么)
37+
- [什么时候直接使用宿主,什么时候用 DevCodex?](#什么时候直接使用宿主什么时候用-devcodex)
3638
- [它如何工作?](#它如何工作)
3739
- [5 分钟开始](#5-分钟开始)
3840
- [安装会改变什么](#安装会改变什么)
@@ -70,10 +72,51 @@ DevCodex 把意图识别、按需上下文、专业 Skill、确认边界、验
7072
| 六宿主适配 | 支持 Codex、Claude Code、GitHub Copilot、Gemini CLI、Grok 和 Cursor(Beta),同时保留能力差异 |
7173
| 按需上下文 | 只加载当前任务需要的项目资料和专业能力 |
7274
| 文件记忆 | 记录任务进度、验证证据与剩余风险 |
73-
| 80+ 内置 Skill | 覆盖开发、修复、审查、测试、发布、文档和平台治理 |
75+
| 80+ 内置专业 Skill | 覆盖开发、修复、审查、测试、发布、文档和平台治理,并按任务渐进加载 |
7476
| 本地优先 | 普通使用不需要额外后台服务 |
7577
| 原生资产共存 | 不接管宿主自己的 Skill、指令或个人配置 |
7678

79+
<!-- devcodex-public:capability-scenarios:start -->
80+
## 安装后,你能解决什么?
81+
82+
安装后获得按任务渐进加载的预置专业 Skill 组合,而不是从零手写每一套流程。下面四类结果由现有 active Skill 约束;它们是代表性路径,不是一次全量加载。
83+
84+
### 1. 需求说得不完整,不知道该先分析、立项还是直接修改。
85+
86+
- **得到什么**:先明确目标、边界、验收和下一步,再进入合适的工作流。
87+
- **代表专业流程**:意图识别、需求与验收、风险驱动验证(intent、dev-default、quality-strategy)
88+
- **诚实边界**:具体路径由任务意图与风险决定;并非每次都加载全部 Skill。
89+
90+
### 2. 只知道报错,却不知道根因、同类路径和回归范围。
91+
92+
- **得到什么**:获得复现、根因、同类检查和定向验证,而不止是一段解释。
93+
- **代表专业流程**:复现与根因、回归范围、用户路径验证(fix-default、test-router、frontend-architecture)
94+
- **诚实边界**:代表 Skill 只在适用阶段加载;不承诺全量修复能力常驻。
95+
96+
### 3. 需求跨前端、业务和接口,宿主的通用提示难以划清责任边界。
97+
98+
- **得到什么**:在适用时获得架构、接口和实现边界的专业路径。
99+
- **代表专业流程**:前端体验、业务领域、API 契约(frontend-architecture、backend-domain-architecture、api-contract-architecture)
100+
- **诚实边界**:是否进入各专业路径取决于真实任务,不把目录展示当作已加载事实。
101+
102+
### 4. 交付前需要测试、排错、交接,下一会话却容易丢失上下文。
103+
104+
- **得到什么**:让风险、验证、报告和续接状态都留下可查证据。
105+
- **代表专业流程**:质量策略、交付准备、文档同步(quality-strategy、production-readiness-sre、document-sync)
106+
- **诚实边界**:不替代人工发布授权、宿主权限或既有 CI。
107+
<!-- devcodex-public:capability-scenarios:end -->
108+
109+
## 什么时候直接使用宿主,什么时候用 DevCodex?
110+
111+
| 场景 | 更合适的选择 | 原因 |
112+
|---|---|---|
113+
| 一次性问答、短小编辑、只依赖某个宿主特有工具 | 直接使用宿主 | 宿主原生能力最快;不需要额外的任务状态或验证链。 |
114+
| 跨文件修改、需要先澄清范围或验收 | DevCodex | 把意图、项目上下文、专业流程和确认边界放到同一条可追踪路径。 |
115+
| 修复问题且担心同类回归 | DevCodex | 把复现、根因、同类检查和定向验证连成闭环,而不是只生成一个解释。 |
116+
| 换宿主、换会话、多人接力或需要留下证据 | DevCodex | 项目级记忆、报告和任务状态让后续会话可以基于文件继续。 |
117+
118+
两者不是替代关系:宿主提供模型、编辑器和原生工具;DevCodex 在适用的工程任务上增加按需专业 Skill、项目边界、验证与续接。它不接管宿主自己的 Skill、指令或个人配置。
119+
77120
## 它如何工作?
78121

79122
```text
@@ -131,6 +174,13 @@ devcodex grok
131174

132175
普通 `grok` 是 Partial 兼容入口。Cursor 本地 IDE / CLI 为 Beta;Cursor Cloud Agent 保持 Partial / `UNVERIFIED`
133176

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+
134184
第一个任务可以直接写:
135185

136186
```text
@@ -194,6 +244,7 @@ devcodex init --profile <项目相对路径>
194244
<!-- devcodex-public:skills total=86 active=83 gray=3 bucket=80+ -->
195245
<!-- devcodex-public:hosts ids=copilot,claude,codex,gemini,grok,cursor variants=13 -->
196246
<!-- devcodex-public:auto canonical=@devcodex-auto default=@rocky profile-replacement=true empty-array-disables=true -->
247+
<!-- devcodex-public:capabilities ids=turn-ambiguous-request-into-action,fix-with-regression-confidence,evolve-cross-domain-change,deliver-with-evidence-and-handoff -->
197248

198249
六个主工作流面向日常任务,两个高级工作流只用于治理或兜底:
199250

public-product-expression.json

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,62 @@
1919
"valuePropositions": [
2020
"按任务意图选择工作流、上下文与专业 Skill",
2121
"把需求、确认、实现、验证、报告和续接形成可追踪闭环",
22-
"在六个 AI Coding 宿主间保持一致流程,同时诚实保留能力差异"
22+
"在六个 AI Coding 宿主间保持一致流程,同时诚实保留能力差异",
23+
"安装后获得按任务渐进加载的预置专业 Skill 组合,而不是从零手写每一套流程"
24+
],
25+
"capabilityScenarios": [
26+
{
27+
"id": "turn-ambiguous-request-into-action",
28+
"userProblem": "需求说得不完整,不知道该先分析、立项还是直接修改。",
29+
"userOutcome": "先明确目标、边界、验收和下一步,再进入合适的工作流。",
30+
"representativeSkillIds": [
31+
"intent",
32+
"dev-default",
33+
"quality-strategy"
34+
],
35+
"skillFocus": "意图识别、需求与验收、风险驱动验证",
36+
"workflowBoundary": "具体路径由任务意图与风险决定;并非每次都加载全部 Skill。",
37+
"nextHref": "/guide/common-tasks"
38+
},
39+
{
40+
"id": "fix-with-regression-confidence",
41+
"userProblem": "只知道报错,却不知道根因、同类路径和回归范围。",
42+
"userOutcome": "获得复现、根因、同类检查和定向验证,而不止是一段解释。",
43+
"representativeSkillIds": [
44+
"fix-default",
45+
"test-router",
46+
"frontend-architecture"
47+
],
48+
"skillFocus": "复现与根因、回归范围、用户路径验证",
49+
"workflowBoundary": "代表 Skill 只在适用阶段加载;不承诺全量修复能力常驻。",
50+
"nextHref": "/guide/common-tasks"
51+
},
52+
{
53+
"id": "evolve-cross-domain-change",
54+
"userProblem": "需求跨前端、业务和接口,宿主的通用提示难以划清责任边界。",
55+
"userOutcome": "在适用时获得架构、接口和实现边界的专业路径。",
56+
"representativeSkillIds": [
57+
"frontend-architecture",
58+
"backend-domain-architecture",
59+
"api-contract-architecture"
60+
],
61+
"skillFocus": "前端体验、业务领域、API 契约",
62+
"workflowBoundary": "是否进入各专业路径取决于真实任务,不把目录展示当作已加载事实。",
63+
"nextHref": "/workflows/"
64+
},
65+
{
66+
"id": "deliver-with-evidence-and-handoff",
67+
"userProblem": "交付前需要测试、排错、交接,下一会话却容易丢失上下文。",
68+
"userOutcome": "让风险、验证、报告和续接状态都留下可查证据。",
69+
"representativeSkillIds": [
70+
"quality-strategy",
71+
"production-readiness-sre",
72+
"document-sync"
73+
],
74+
"skillFocus": "质量策略、交付准备、文档同步",
75+
"workflowBoundary": "不替代人工发布授权、宿主权限或既有 CI。",
76+
"nextHref": "/concepts/evidence-and-completion"
77+
}
2378
],
2479
"mustNot": [
2580
"model-gateway",

public-site/data/public-product-projection.json

Lines changed: 58 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"schemaVersion": "PublicProductProjectionV1",
3-
"generatedAt": "2026-08-18T13:57:42.041Z",
3+
"generatedAt": "2026-08-19T04:50:59.452Z",
44
"workflows": {
55
"canonical": [
66
"dev",
@@ -31,6 +31,60 @@
3131
"gray": 3,
3232
"bucket": "80+"
3333
},
34+
"capabilityScenarios": [
35+
{
36+
"id": "turn-ambiguous-request-into-action",
37+
"userProblem": "需求说得不完整,不知道该先分析、立项还是直接修改。",
38+
"userOutcome": "先明确目标、边界、验收和下一步,再进入合适的工作流。",
39+
"representativeSkillIds": [
40+
"intent",
41+
"dev-default",
42+
"quality-strategy"
43+
],
44+
"skillFocus": "意图识别、需求与验收、风险驱动验证",
45+
"workflowBoundary": "具体路径由任务意图与风险决定;并非每次都加载全部 Skill。",
46+
"nextHref": "/guide/common-tasks"
47+
},
48+
{
49+
"id": "fix-with-regression-confidence",
50+
"userProblem": "只知道报错,却不知道根因、同类路径和回归范围。",
51+
"userOutcome": "获得复现、根因、同类检查和定向验证,而不止是一段解释。",
52+
"representativeSkillIds": [
53+
"fix-default",
54+
"test-router",
55+
"frontend-architecture"
56+
],
57+
"skillFocus": "复现与根因、回归范围、用户路径验证",
58+
"workflowBoundary": "代表 Skill 只在适用阶段加载;不承诺全量修复能力常驻。",
59+
"nextHref": "/guide/common-tasks"
60+
},
61+
{
62+
"id": "evolve-cross-domain-change",
63+
"userProblem": "需求跨前端、业务和接口,宿主的通用提示难以划清责任边界。",
64+
"userOutcome": "在适用时获得架构、接口和实现边界的专业路径。",
65+
"representativeSkillIds": [
66+
"frontend-architecture",
67+
"backend-domain-architecture",
68+
"api-contract-architecture"
69+
],
70+
"skillFocus": "前端体验、业务领域、API 契约",
71+
"workflowBoundary": "是否进入各专业路径取决于真实任务,不把目录展示当作已加载事实。",
72+
"nextHref": "/workflows/"
73+
},
74+
{
75+
"id": "deliver-with-evidence-and-handoff",
76+
"userProblem": "交付前需要测试、排错、交接,下一会话却容易丢失上下文。",
77+
"userOutcome": "让风险、验证、报告和续接状态都留下可查证据。",
78+
"representativeSkillIds": [
79+
"quality-strategy",
80+
"production-readiness-sre",
81+
"document-sync"
82+
],
83+
"skillFocus": "质量策略、交付准备、文档同步",
84+
"workflowBoundary": "不替代人工发布授权、宿主权限或既有 CI。",
85+
"nextHref": "/concepts/evidence-and-completion"
86+
}
87+
],
3488
"hosts": [
3589
{
3690
"hostId": "copilot",
@@ -79,10 +133,11 @@
79133
"workflows": "<!-- devcodex-public:workflows primary=dev,fix,analyze,audit,resume,chat advanced=self-fix,other -->",
80134
"skills": "<!-- devcodex-public:skills total=86 active=83 gray=3 bucket=80+ -->",
81135
"hosts": "<!-- devcodex-public:hosts ids=copilot,claude,codex,gemini,grok,cursor variants=13 -->",
82-
"auto": "<!-- devcodex-public:auto canonical=@devcodex-auto default=@rocky profile-replacement=true empty-array-disables=true -->"
136+
"auto": "<!-- devcodex-public:auto canonical=@devcodex-auto default=@rocky profile-replacement=true empty-array-disables=true -->",
137+
"capabilities": "<!-- devcodex-public:capabilities ids=turn-ambiguous-request-into-action,fix-with-regression-confidence,evolve-cross-domain-change,deliver-with-evidence-and-handoff -->"
83138
},
84139
"sourceIdentities": {
85-
"expression": "4e60fd53c93a759bb0ca572df93e598b6a8106fe380dbe76c909e7aee1acc315",
140+
"expression": "89e6183824f75371c7912d2d3cd2ba129c33560b25e2809ff9b49d4e68bcb1e3",
86141
"workflows": "8577bb60f9fac3efac4abb9d8c31b95df9b5c31ab77b664d44dde3f252fcd825",
87142
"portfolio": "a48e3f5af9488d01e82028ef9952d14bf9c7094fa3bb751fbb8f42a4175aa7cc"
88143
}

public-site/docs/guide/common-tasks.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,17 @@
22

33
用户不需要记住内部阶段。一个清楚的请求通常包含:目标、范围与约束、验证要求,以及是否提交或发布。
44

5+
## 先选择:直接使用宿主,还是使用 DevCodex
6+
7+
| 你的目标 | 建议 | 原因 |
8+
|---|---|---|
9+
| 问一个一次性问题、做短小编辑、依赖单个宿主的原生工具 | 直接使用宿主 | 更快,不需要项目状态、确认或验证链。 |
10+
| 跨文件变更、需要先明确范围或验收 | 使用 DevCodex | 让项目上下文、专业 Skill 和确认边界按任务进入。 |
11+
| 修复报错且担心同类回归 | 使用 DevCodex | 适合把复现、根因、同类检查和定向验证连起来。 |
12+
| 需要换会话、换宿主或交给他人继续 | 使用 DevCodex | 任务状态、报告和记忆写在项目中,后续可以继续。 |
13+
14+
两者可以一起用:宿主继续提供模型和原生工具,DevCodex 只在需要工程流程增强时补上上下文、专业路径、验证和续接。
15+
516
## 只读分析
617

718
```text

public-site/docs/guide/getting-started.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,13 @@ devcodex status
3434

3535
`devcodex init` 创建 `.devcodex/` 运行态。多项目 workspace 可以只在 workspace 根初始化;子项目会按稳定命名空间保存自己的报告、记忆和任务状态。
3636

37+
### 这一步成功后能看到什么
38+
39+
- `devcodex --version` 能返回已安装版本;
40+
- 项目根出现 `.devcodex/`,且 `devcodex status` 能输出当前项目状态;
41+
- 安装不等于把所有 83 个 active Skill 一次塞进会话:它们会按后续任务的意图和阶段渐进路由;
42+
- 如果状态提示 adapter 未就绪、契约失败或入口不明确,再执行 `devcodex doctor`,然后按 [故障排查](/guide/troubleshooting) 恢复。
43+
3744
## 4. 新建宿主会话
3845

3946
完全退出旧会话,再在同一项目目录打开 Codex、Claude Code、GitHub Copilot、Gemini CLI、Grok 或 Cursor 的新会话。已经打开的会话不会在中途自动换用新版本。

public-site/docs/index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ pageType: home
33
hero:
44
name: DevCodex
55
text: Intent-driven AI Coding Workflow Runtime
6-
tagline: 一条请求进来之后:判断意图 → 加载上下文和 Skill → 按工作流确认与验证 → 必要时跨会话续接
6+
tagline: 安装后,按任务渐进加载预置专业 Skill:把模糊请求变成可执行、可验证、可续接的工程任务
77
actions:
88
- text: 5 分钟开始
99
link: /guide/getting-started
1010
theme: brand
11-
- text: 它怎么跑
12-
link: /concepts/architecture
11+
- text: 能解决什么
12+
link: /guide/common-tasks
1313
theme: alt
1414
- text: 续接案例
1515
link: /examples/resume
@@ -43,6 +43,7 @@ DevCodex 是面向 Codex、Claude Code、GitHub Copilot、Gemini CLI、Grok 和
4343
<!-- devcodex-public:skills total=86 active=83 gray=3 bucket=80+ -->
4444
<!-- devcodex-public:hosts ids=copilot,claude,codex,gemini,grok,cursor variants=13 -->
4545
<!-- devcodex-public:auto canonical=@devcodex-auto default=@rocky profile-replacement=true empty-array-disables=true -->
46+
<!-- devcodex-public:capabilities ids=turn-ambiguous-request-into-action,fix-with-regression-confidence,evolve-cross-domain-change,deliver-with-evidence-and-handoff -->
4647

4748
它不会托管模型,也不是通用 Agent 框架或多 Agent 编排器。它在本地保存工作流状态、Profile、报告、记忆和项目 Skill;模型执行与数据处理仍遵循所选宿主的规则。
4849

47.3 KB
Loading

public-site/rspress.config.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ export default defineConfig({
55
outDir: 'doc_build',
66
base: '/devcodex/',
77
lang: 'zh',
8+
icon: '/favicon.png',
9+
logo: '/favicon.png',
10+
logoText: 'DevCodex',
811
title: 'DevCodex — Intent-driven AI Coding Workflow Runtime',
912
description: '把自然语言研发请求组织成有上下文、有边界、有验证、可续接的工程工作流。',
1013
markdown: {

0 commit comments

Comments
 (0)