Skip to content

Commit ed04c7e

Browse files
committed
refactor(docs): 收敛旧能力描述与编号规则
统一 active 文档、skill、schema 与 CLI 内部输出的正向规则,移除旧 ID/lookup/trace/contract service 叙事和未暴露旧命令死代码。
1 parent 497da30 commit ed04c7e

53 files changed

Lines changed: 162 additions & 347 deletions

File tree

Some content is hidden

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

AGENTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
- 默认使用中文回复和编写文档,除非用户明确要求其他语言。
44
- 保持 Aisee、OpenSpec、Compound Engineering 的职责边界清晰。
55
- OpenSpec change 和 baseline 是规范事实源;不要创建平行规范事实源。
6-
- Aisee CLI 的 JSON 输出应调用时解析 Markdown、OpenSpec artifacts、`aisee/registry/sources.json``aisee/registry/id-registry.json``source-map.md`
7-
- `aisee/cache/context-index.json` 只能作为可删除、可重建的缓存,不能作为事实源
6+
- Aisee CLI 的 JSON 输出应调用时解析 Markdown、OpenSpec artifacts、`source-map.md``tasks.md`、evidence 和少量 planning doc metadata
7+
- 不要把编号、索引或缓存升级成独立规范事实源;context pack 的内部扫描视图只服务本次输出
88
- `tasks.md` 是唯一长期任务清单;`ce-plan` 只能作为按需细化器,结论必须回写 `tasks.md``source-map.md`
99
- 修改 skill 时保持 `SKILL.md` 精简,将长规则放入 `references/``docs/architecture/`
1010
- 不要把教程站内容放入本仓库。

README.en.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Core boundaries:
8888

8989
```text
9090
OpenSpec = specification state machine and baseline source of truth
91-
Aisee = planning, context, schemas, traceability, and workflow guardrails
91+
Aisee = planning, context, schemas, source routing, and workflow guardrails
9292
Aisee CLI = JSON context bus, not a second source of truth
9393
Compound Engineering = optional implementation / review / test consumer
9494
```
@@ -206,7 +206,7 @@ aisee doctor --json
206206

207207
When reading plugin content, the CLI checks only the Codex install location by default. For other agent runtimes, set `AISEE_AGENT_RUNTIME=claude|cursor|agents`; set it to `none` to disable installed plugin content discovery.
208208

209-
`aisee plugin export`, `aisee schemas install`, and `aisee knowledge scaffold` have been removed from the public CLI surface. Plugin content, schema packs, and team knowledge templates now come from the Codex marketplace plugin or external repositories; team knowledge onboarding now uses `aisee knowledge init-repo` and `aisee knowledge configure`.
209+
Plugin content, schema packs, and team knowledge templates come from the Codex marketplace plugin or external repositories; team knowledge onboarding uses `aisee knowledge init-repo` and `aisee knowledge configure`.
210210

211211
The source repository also includes plugin metadata for multiple agent runtimes:
212212

@@ -307,7 +307,7 @@ For existing projects, use `aisee:spec-migrate` to derive OpenSpec baseline spec
307307
| `aisee:change-plan` | Plan independent OpenSpec changes and choose schemas. |
308308
| `aisee-schema-pack` | Provide and maintain OpenSpec schema packs through the marketplace plugin. |
309309
| `aisee:implementation-bridge` | Produce implementation briefs and context pack summaries for a single change. |
310-
| `aisee:verify` | Diagnose artifact, task, source-map, ID, and evidence gaps. |
310+
| `aisee:verify` | Diagnose artifact, task, source-map, numbering, and evidence gaps. |
311311
| `aisee:archive-guard` | Provide the final recommendation before `openspec archive`. |
312312
| `aisee:spec-migrate` | Build OpenSpec baseline specs for existing projects. |
313313
| `aisee:design-spec` | Produce design specifications without duplicating UI content specs. |

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ aisee doctor --json
215215

216216
CLI 读取插件内容时默认只检查 Codex 安装位置。需要对接其它 agent runtime 时,可设置 `AISEE_AGENT_RUNTIME=claude|cursor|agents`;设置为 `none` 可关闭已安装插件内容发现。
217217

218-
`aisee plugin export``aisee schemas install``aisee knowledge scaffold` 已从公开 CLI 命令面移除。插件内容、schema pack 和 team knowledge 模板通过 Codex marketplace 插件或外部仓库获取;team knowledge onboarding 改为 `aisee knowledge init-repo``aisee knowledge configure`
218+
插件内容、schema pack 和 team knowledge 模板通过 Codex marketplace 插件或外部仓库获取;team knowledge onboarding 使用 `aisee knowledge init-repo``aisee knowledge configure`
219219

220220
源码仓库也包含多个 agent runtime 的插件元数据:
221221

docs/architecture/aisee-cli-context-and-id-registry.md

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

33
## 维护边界
44

5-
本文描述当前生效的 Aisee CLI 上下文设计。Aisee 不再提供独立的 ID lifecycle、anchor lookup 或跨项目制品读取能力。
5+
本文描述当前生效的 Aisee CLI 上下文设计。
66

77
事实源以以下内容为准:
88

@@ -22,21 +22,14 @@ Aisee CLI 不是第二套规范系统。它只做四件事:
2222

2323
## 2. 编号模型
2424

25-
编号是 skill/template 的写作约束,不是独立 CLI 能力
25+
编号是 skill/template 的写作约束。
2626

2727
正式规则:
2828

2929
- 文档内编号使用 `FR-001``PAGE-001``ARCH-001``SPEC-001``TASK-001` 等格式。
3030
- 无法确定最终编号时,使用 `TYPE-NEW-001` 并标注 `[NUMBERING-FINALIZATION-REQUIRED]`
3131
- 编号只用于减少重复命名、方便人工阅读和让 `source-map.md` / context pack 能做轻量解析。
3232

33-
以下不再是当前模型:
34-
35-
- 旧 ID lifecycle 命令
36-
- 独立 lookup / trace 命令
37-
- full ID lifecycle
38-
- 把编号系统包装成跨项目 traceability 服务
39-
4033
## 3. 事实源分工
4134

4235
|| 作用 | 是否事实源 |
@@ -58,7 +51,7 @@ Aisee CLI 不是第二套规范系统。它只做四件事:
5851
- `guardrails`
5952
- `evidence`
6053

61-
它依赖 `source-map.md`、当前 change artifacts、review / verification evidence 和 schema metadata。内部扫描只服务本次输出,不作为公开 `index` 命令或持久事实源
54+
它依赖 `source-map.md`、当前 change artifacts、review / verification evidence 和 schema metadata。内部扫描只服务本次输出,不是持久事实源
6255

6356
## 5. Source Map 规则
6457

docs/architecture/aisee-openspec-compound-integration.md

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

33
## 维护边界
44

5-
本文记录当前生效的高层职责边界和主流程。旧 full ID lifecycle、独立 lookup / trace 命令、跨项目制品读取和本地 context 服务都不再属于当前方案。
5+
本文记录当前生效的高层职责边界和主流程。
66

77
细节以以下事实源为准:
88

@@ -43,7 +43,7 @@ Compound Engineering
4343
- `aisee:design-assets`
4444
- `aisee:architecture`
4545

46-
编号规则由对应 skill 约束,例如 `FR-001``PAGE-001``ARCH-001`。编号用于写作一致性,不形成独立 CLI 生命周期
46+
编号规则由对应 skill 约束,例如 `FR-001``PAGE-001``ARCH-001`。编号用于写作一致性。
4747

4848
### Change 规划
4949

@@ -67,7 +67,7 @@ Compound Engineering
6767

6868
- 文档内编号由 skill/template 约束。
6969
- 跨文档来源和候选影响路径由 `source-map.md` 记录。
70-
- 不要求旧 ID lifecycle 或独立 lookup / trace 流程
70+
- 不要求额外的编号前置流程
7171

7272
### Implementation
7373

docs/best-practices.en.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -132,12 +132,12 @@ Document-local numbers reduce duplicate naming and let source-map and context pa
132132
Recommended:
133133

134134
- Use document-local numbers such as `FR-001`, `PAGE-001`, or `API-001`.
135-
- Put cross-document sources in `source-map.md`; do not create an extra ID lifecycle.
135+
- Put cross-document sources in `source-map.md`; keep only routing information useful for implementation and verification.
136136
- Keep temporary `TYPE-NEW-001` IDs short-lived; they must not enter archive.
137137
- When replacing or removing numbers, keep migration notes.
138138
- Do not treat headings, filenames, or natural-language descriptions as stable identifiers.
139139

140-
Use `source-map.md` and context pack's rebuildable scan view as context entries; do not return to the full ID lifecycle model.
140+
Use `source-map.md` and context pack's rebuildable scan view as context entries; durable specification facts still belong in OpenSpec artifacts and baseline specs.
141141

142142
## 8. Context Pack Is A Read Entry, Not A New Document
143143

@@ -229,10 +229,9 @@ Read the current project's OpenSpec artifacts directly or use `aisee context pac
229229
Best practices:
230230
231231
- The provider owns the contract source.
232-
- The consumer reads manifest first, then summary or sections as needed.
233-
- Use `max_chars` to control context size.
234-
- LAN access requires explicit `--host 0.0.0.0`.
235-
- Do not use the contract service to expose source code, secrets, environment variables, or full-repository search results.
232+
- The consumer only reads explicitly shared OpenSpec artifacts, contract attachments, or context pack summaries.
233+
- Use human-confirmed paths and excerpts to keep context bounded.
234+
- Do not expose source code, secrets, environment variables, or full-repository search results.
236235
237236
## 14. Team Knowledge Only Provides Guardrails
238237

docs/best-practices.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -132,12 +132,12 @@ data-model.md
132132
推荐:
133133

134134
- 文档内编号使用 `FR-001``PAGE-001``API-001`
135-
- 跨文档来源放进 `source-map.md`不要额外创建 ID lifecycle
135+
- 跨文档来源放进 `source-map.md`只保留对实现和验证有用的路由信息
136136
- 临时 `TYPE-NEW-001` 只能短期存在,不能进入 archive。
137137
- 删除或替换编号时保留迁移说明。
138138
- 不把标题、文件名或自然语言描述当作稳定标识。
139139

140-
`source-map.md` 和 context pack 的可重建扫描视图只提供上下文入口;不要回到 full ID lifecycle 模型
140+
`source-map.md` 和 context pack 的可重建扫描视图只提供上下文入口;长期规范事实仍回写 OpenSpec artifacts 和 baseline specs
141141

142142
## 8. Context pack 是读取入口,不是新文档
143143

@@ -160,7 +160,7 @@ aisee context pack --change <change> --for ce-code-review --json
160160

161161
创建任务、进入实现、提出审查角色或推荐下一步前,先检查已有 workflow 和 skill:
162162

163-
- 无明确 change 时,先回到需求澄清、change-plan 或当前 change 本身,不再依赖单独的 flow 命令判断阶段
163+
- 无明确 change 时,先回到需求澄清、change-plan 或当前 change 本身。
164164
- 有明确 change 时,优先读取目标 context pack,例如 `aisee context pack --change <change> --for ce-work --json`
165165
- `ce-work` context pack 的 `reusable_workflow_candidates` 只是路由提示,不是事实源。
166166
- `requires_ce_plan=true` 时才按需使用 `ce-plan` 细化执行顺序;结论必须回写当前 schema apply tracks,只有 source-map schema 才回写 `source-map.md`
@@ -229,10 +229,9 @@ archive 前应满足:
229229
最佳实践:
230230

231231
- provider 拥有 contract source。
232-
- consumer 先读 manifest,再按需读 summary 或 section。
233-
-`max_chars` 控制上下文大小。
234-
- 局域网访问必须显式开启 `--host 0.0.0.0`
235-
- 不用 contract service 暴露源码、密钥、环境变量或全仓库搜索结果。
232+
- consumer 只读取 provider 明确提供的 OpenSpec artifacts、契约附件或 context pack 摘要。
233+
- 用人工确认的路径和摘录控制上下文大小。
234+
- 不暴露源码、密钥、环境变量或全仓库搜索结果。
236235

237236
## 14. Team knowledge 只提供 guardrails
238237

docs/compatibility-policy.en.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,9 @@ The following are public contracts:
9090
- `plugins/aisee-plugin/.codex-plugin/plugin.json`, `plugins/aisee-plugin/skills/`, `plugins/aisee-plugin/references/`, and schema pack directories in the GitHub repository remain loadable by the Codex marketplace plugin;
9191
- the core / optional / knowledge / hardware layering defined in `plugins/aisee-plugin/references/skill-taxonomy.md`, including the core set of 11 workflow skills;
9292
- `aisee plugin inspect --json` returns stable status and setup hints in CLI-only installs;
93-
- `aisee plugin export`, `aisee schemas install`, and `aisee knowledge scaffold` have been removed from the public CLI surface;
94-
- the PyPI wheel no longer promises bundled copies of skills, references, schema packs, team knowledge templates, or plugin metadata.
93+
- the PyPI wheel only promises CLI capabilities; skills, references, schema packs, team knowledge templates, and plugin metadata are distributed through the marketplace plugin or external repositories.
9594

96-
Breaking changes include renaming the plugin, removing the Codex manifest, breaking the marketplace plugin root layout, changing the core set of 11 workflow skills, or reintroducing legacy content-distribution commands without a clear single owner.
95+
Breaking changes include renaming the plugin, removing the Codex manifest, breaking the marketplace plugin root layout, or changing the core workflow skill set.
9796

9897
### Plugin Marketplace
9998

@@ -114,11 +113,11 @@ See [Plugin Marketplace](plugin-marketplace.en.md) for details.
114113
The following are public contracts:
115114

116115
- the planning-doc frontmatter contract and the read-only diagnostics exposed through `aisee doctor --json` and `aisee context pack --json`;
117-
- the basic semantics of planning-doc fields such as `status`, `doc_type`, `source_refs`, `change_refs`, and `anchors`;
116+
- the basic semantics of planning-doc fields such as `status`, `doc_type`, `source_refs`, and `change_refs`;
118117
- `resolve_project_root` preferring the nearest Aisee/OpenSpec project marker before falling back to the Git top-level;
119-
- release smoke checks for CLI-only wheels, marketplace setup hints, removed-command invalid choice behavior, and root-resolver fixtures.
118+
- release smoke checks for CLI-only wheels, marketplace setup hints, the public command surface, and root-resolver fixtures.
120119

121-
Breaking changes include turning planning-doc diagnostics into write commands, changing root resolution so monorepo subprojects are silently interpreted as repository roots, or restoring old blocker-JSON assumptions for removed commands.
120+
Breaking changes include turning planning-doc diagnostics into write commands or changing root resolution so monorepo subprojects are silently interpreted as repository roots.
122121

123122
## Experimental Contracts
124123

@@ -148,7 +147,7 @@ The following are not stable contracts or sources of truth:
148147
- internal test fixture layout;
149148
- chat summaries.
150149

151-
Caches must be deletable and rebuildable. Sources of truth can only come from OpenSpec artifacts, Aisee registry, source-map, tasks, and explicitly pinned team knowledge card/pack files.
150+
Caches must be deletable and rebuildable. Sources of truth can only come from OpenSpec artifacts, source-map, tasks, and explicitly pinned team knowledge card/pack files.
152151

153152
## Version Rules
154153

docs/compatibility-policy.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,9 @@
9090
- GitHub 仓库中的 `plugins/aisee-plugin/.codex-plugin/plugin.json``plugins/aisee-plugin/skills/``plugins/aisee-plugin/references/` 和 schema pack 目录保持可被 Codex marketplace plugin 加载;
9191
- `plugins/aisee-plugin/references/skill-taxonomy.md` 中 core / optional / knowledge / hardware 分层,以及 core 11 skill 集合;
9292
- `aisee plugin inspect --json` 在 CLI-only 安装中返回稳定状态和 setup hint;
93-
- `aisee plugin export``aisee schemas install``aisee knowledge scaffold` 已从公开 CLI 命令面移除;
94-
- PyPI wheel 不再承诺包含 skills、references、schema packs、team knowledge templates 或 plugin metadata 副本。
93+
- PyPI wheel 只承诺 CLI 能力;skills、references、schema packs、team knowledge templates 和 plugin metadata 通过 marketplace plugin 或外部仓库分发。
9594

96-
破坏性变更包括重命名插件、移除 Codex manifest、破坏 marketplace plugin root 布局、改变 core 11 skill 集合,或改变旧公开命令的 JSON blocker 语义
95+
破坏性变更包括重命名插件、移除 Codex manifest、破坏 marketplace plugin root 布局,或改变 core workflow skill 集合。
9796

9897
### Plugin Marketplace
9998

@@ -114,11 +113,11 @@
114113
以下属于公开契约:
115114

116115
- 普通 planning docs 的 frontmatter 合同和 `aisee doctor --json` / `aisee context pack --json` 的只读 diagnostics;
117-
- `status``doc_type``source_refs``change_refs``anchors` 等 planning doc 索引字段的基本语义;
116+
- `status``doc_type``source_refs``change_refs` 等 planning doc 索引字段的基本语义;
118117
- `resolve_project_root` 以最近的 Aisee/OpenSpec project marker 优先,再 fallback 到 Git 顶层的语义;
119-
- release smoke 对 CLI-only wheel、marketplace setup hint、removed command invalid choice 和 root resolver fixture 的检查重点。
118+
- release smoke 对 CLI-only wheel、marketplace setup hint、公开命令面和 root resolver fixture 的检查重点。
120119

121-
破坏性变更包括把 planning doc diagnostics 变成写入命令、改变 root resolution 使 monorepo 子项目误读为仓库顶层,或恢复对已删除命令的旧 blocker JSON 假设
120+
破坏性变更包括把 planning doc diagnostics 变成写入命令,或改变 root resolution 使 monorepo 子项目误读为仓库顶层。
122121

123122
## Experimental Contracts
124123

@@ -148,7 +147,7 @@ Experimental 能力可以变化,但文档必须清楚说明:
148147
- 测试 fixture 的内部组织;
149148
- chat summary。
150149

151-
缓存必须可删除、可重建;事实源只能来自 OpenSpec artifacts、Aisee registry、source-map、tasks、明确 pin 的 team knowledge card/pack。
150+
缓存必须可删除、可重建;事实源只能来自 OpenSpec artifacts、source-map、tasks、明确 pin 的 team knowledge card/pack。
152151

153152
## 版本规则
154153

docs/schema-packs.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Schema Packs
22

3-
Schema pack 定义 OpenSpec change 内需要生成哪些 artifacts、它们的依赖顺序、模板和 authoring 规则。它不替代 OpenSpec,也不保存项目事实;项目事实仍来自 OpenSpec specs、change artifacts、`source-map.md``tasks.md` 和 Aisee registry
3+
Schema pack 定义 OpenSpec change 内需要生成哪些 artifacts、它们的依赖顺序、模板和 authoring 规则。它不替代 OpenSpec,也不保存项目事实;项目事实仍来自 OpenSpec specs、change artifacts、`source-map.md``tasks.md`
44

55
## 目录
66

@@ -91,7 +91,7 @@ source-map.md + specs/**/*.md
9191
| Artifact | 写什么 | 不写什么 |
9292
| --- | --- | --- |
9393
| `proposal.md` | 目标、非目标、成功标准、读取顺序 | 接口字段、数据库字段、任务步骤 |
94-
| `source-map.md` | ID 路由、来源、artifact 适用性、候选影响路径、预期证据类型 | 具体实现步骤或最终验证结论 |
94+
| `source-map.md` | 来源路由、artifact 适用性、候选影响路径、预期证据类型 | 具体实现步骤或最终验证结论 |
9595
| `specs/**/*.md` | 用户可观察行为和验收场景 | UI 布局、API 字段、表字段、代码路径 |
9696
| `change-context.md` | 本 change 承接的架构约束、局部决策和风险 | 全局架构重写 |
9797
| `ui-contract.md` | 页面内容结构、交互状态、权限可见性、前端数据需求 | 完整视觉规范、组件库、配色、像素布局 |
@@ -107,7 +107,7 @@ source-map.md + specs/**/*.md
107107
LOCAL-ID
108108
```
109109

110-
AI 不应临时发明 full ID。工具不可用时只能使用临时 local placeholder
110+
无法确定最终编号时使用临时编号占位符
111111

112112
```text
113113
TYPE-NEW-001 [NUMBERING-FINALIZATION-REQUIRED]
@@ -156,7 +156,7 @@ aisee schemas list --json
156156
aisee schemas check --json --fail-on-blocker
157157
```
158158

159-
`aisee schemas install` 已从公开 CLI 命令面移除。需要 schema pack 内容时,通过 marketplace-installed plugin 的 `aisee-schema-pack` 工作流读取并复制插件内 schema,或从外部仓库同步。
159+
需要 schema pack 内容时,通过 marketplace-installed plugin 的 `aisee-schema-pack` 工作流读取并复制插件内 schema,或从外部仓库同步。
160160

161161
创建 app change:
162162

0 commit comments

Comments
 (0)