[docs][refactor]: 将旧 01~06 中文教程合并整理为 modules/frameworks 文件夹结构
- 删除 01~05 旧中文教程目录 - 将 03 核心功能教程拆分为各 framework 模块的子文档 - 06 工具脚本移入 modules/frameworks/编辑器工具/UI工具/ - 非框架内容合并进 rules/20-开发规则.md 与 rules/40-工作流清单.md - 更新所有交叉链接与文档关联表 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
57
specs/Spec索引.md
Normal file
57
specs/Spec索引.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# Spec 索引
|
||||
|
||||
大需求、新模块、架构调整、生成流程调整等 Spec 任务在这里沉淀方案和结果。
|
||||
|
||||
## 使用规则
|
||||
|
||||
- 简单修复和旧模块修复不需要创建 spec,按规则直接处理并执行归档检查。
|
||||
- 大需求 / 新模块使用 OpenSpec 流程:
|
||||
- Claude Code 命令 `/opsx:propose "需求描述"` 创建 change。
|
||||
- 生成 `proposal.md`、`design.md`、`tasks.md`。
|
||||
- `/opsx:apply` 执行实现。
|
||||
- `/opsx:archive` 归档到 `openspec/changes/archive/`。
|
||||
- OpenSpec 归档后,再按 [归档规则](../rules/50-归档规则.md) 同步到项目既有模块文档:
|
||||
- `specs/openspec/<change-name>/`
|
||||
- `modules/<module>/业务参考总入口.md`、`progress.md`、`tasks.md`
|
||||
- `rules/10-架构说明.md`、`rules/30-模块登记规则.md`
|
||||
- 如果不用 OpenSpec,也可复制 [Spec模板.md](Spec模板.md) 创建普通 spec。
|
||||
|
||||
## OpenSpec 归档
|
||||
|
||||
大需求 / 新模块经 OpenSpec 流程后,长期归档优先放在:
|
||||
|
||||
```text
|
||||
specs/openspec/
|
||||
```
|
||||
|
||||
详见 [specs/openspec/OpenSpec归档.md](openspec/OpenSpec归档.md)。
|
||||
|
||||
## 命名建议
|
||||
|
||||
普通 spec 文件:
|
||||
|
||||
```text
|
||||
YYYY-MM-DD-feature-name.md
|
||||
```
|
||||
|
||||
OpenSpec change:
|
||||
|
||||
```text
|
||||
kebab-case-change-name
|
||||
```
|
||||
|
||||
## 文档关联
|
||||
|
||||
- [工作流清单](../rules/40-工作流清单.md):任务分类、修复流程、Spec 流程、提交前检查、生成/构建流程。
|
||||
- [大需求 / 新模块工作流](../rules/60-新特性工作流.md):新增/已有功能判断、模块登记、联动更新检查。
|
||||
- [归档规则](../rules/50-归档规则.md):归档时机、内容、格式和关联更新原则。
|
||||
- [模块索引](../modules/模块索引.md):项目功能、框架、编辑器工具模块总览。
|
||||
|
||||
## 同步要求
|
||||
|
||||
OpenSpec change 完成后,必须将结论同步到项目模块文档:
|
||||
|
||||
- `specs/openspec/<change-name>/` — OpenSpec 归档目录
|
||||
- `modules/<module>/业务参考总入口.md`、`progress.md`、`tasks.md` — 相关模块文档
|
||||
- `rules/10-架构说明.md`(如涉及架构变化)
|
||||
- `rules/30-模块登记规则.md`(如新增模块)
|
||||
Reference in New Issue
Block a user