docs(api): sync active and archived API entry docs

This commit is contained in:
2026-04-10 17:27:29 +08:00
parent e2e4e08479
commit 46fac8a215
6 changed files with 109 additions and 37 deletions

View File

@@ -1,8 +1,9 @@
# XCEngine API Documentation Skill
# XCEngine / XCEditor API Documentation Skill
## 目标
这份规范面向维护 `XCEngine` API 文档的 coding agent。它的目标不是“批量生成一套看起来完整的文档”而是持续把当前源码、测试和真实调用链路同步到唯一的 canonical API 文档树里。
这份规范面向维护 `XCEngine` / `XCEditor` API 文档的 coding agent。它的目标不是“批量生成一套看起来完整的文档”而是持续把当前源码、测试和真实调用链路同步到当前活跃的 canonical API 文档树里。
当前仓库已经进入“增量同步”阶段。重点不再是补骨架,而是:
@@ -12,11 +13,14 @@
## 当前范围
API 文档的正式范围包含部分:
API 文档的正式范围包含部分:
1. 引擎 public API
- 对齐 `engine/include/XCEngine/**`
2. Editor source-backed API
2. Editor public API
- 对齐 `new_editor/include/XCEditor/**`
- canonical 文档入口放在 `docs/api/XCEditor/**`
3. Editor source-backed API
- 对齐 `editor/src/**`
- canonical 文档入口仍放在 `docs/api/XCEngine/Editor/**`
@@ -28,35 +32,46 @@ API 文档的正式范围包含两部分:
- 审计结果、阶段性状态
- `docs/api/_tools/**`
- 审计、生成、修链脚本
- `docs/plan/API文档实时同步任务池_2026-04-03.md`
- 当前多任务并行同步池
- `docs/plan/API文档目录*.md`
- 当前活跃 API 计划、重构计划与并行任务板
- `docs/plan/API文档目录结构阶段进度_XCEditor与Model收口_2026-04-10.md`
- 最近一轮 `XCEditor / Model / GaussianSplat` 收口记录
- `docs/used/API文档实时同步任务池_2026-04-03.md`
- 最近一轮已完成的归档基线
- `README.md` / `editor/README.md` / `AGENT.md`
- 这些不是 canonical API 页,但一旦它们引用 API 模块结构、测试目录或 Editor helper 分层,就属于必须同步的活跃协作文档
## 硬约束
1. `docs/api/XCEngine/**` 是唯一 canonical API 树
1. `docs/api/XCEngine/**` `docs/api/XCEditor/**` 是当前两棵 canonical API 树;`docs/api/XCEngine/Editor/**` 继续承载 `editor/src/**` 的 source-backed 文档入口
2. 文档必须以“当前 header + 当前实现 + 当前测试 + 当前真实调用点”为依据,不能按旧文档或命名猜行为。
3. 删除的 API 页面要一起删除,相关交叉链接也必须一起清理。
4. 方法页优先使用源码中的原始函数名;不要擅自改成 kebab-case 或小写别名。
5. 不要把“设计意图”写成“当前实现行为”。
6. 不要为已经删除的 API 保留默认兼容入口页,除非任务明确要求。
7. `rebuild-status.md` 以审计脚本输出为准并发场景下stdout 比旧文件内容更可信。
8. 收口活跃文档;`docs/plan/used/**``docs/used/**` 等归档材料默认保留历史写法,不要为了“顺手统一”去重写归档
8. 默认先收口活跃文档;只有当任务明确涉及归档链、入口路径或历史基线说明时,才修改 `docs/used/**`
9. Windows 工作树里的路径大小写按真实目录名写,例如 `tests/Editor/``tests/Core/``tests/Scripting/`,不要继续传播 `tests/editor/``tests/core/` 之类的历史噪音。
## 工作流
### 1. 开工前先看两文件
### 1. 开工前先看两文件
- 任务池
- `docs/plan/API文档实时同步任务池_2026-04-03.md`
- 最新活跃计划
- `docs/plan/API文档目录*.md`
- `docs/plan/API文档目录结构阶段进度_XCEditor与Model收口_2026-04-10.md`
- 最新审计:
- `docs/api/_meta/rebuild-status.md`
如果任务池和工作树不一致,以当前源码和重新执行审计后的结果为准。
如果活跃计划和工作树不一致,以当前源码和重新执行审计后的结果为准。
如果 `docs/plan/` 下出现日期更晚的 API 相关计划或归档文件,优先读取更新日期更晚的文件,再判断当前任务池是否已经转入 `docs/plan/used/`
如果当前活跃计划没有覆盖你的问题,再回看:
- `docs/used/API文档实时同步任务池_2026-04-03.md`
作为最近一轮完成归档的基线。
如果 `docs/plan/` 下出现日期更晚的 API 相关计划,优先读取日期更晚的活跃文件;当前仓库里的归档根目录是 `docs/used/**`,不要再假设存在 `docs/plan/used/**`
如果工作内容会改到 `README.md``editor/README.md``AGENT.md`
@@ -121,10 +136,13 @@ python -B docs/api/_tools/audit_api_docs.py
- `docs/api/main.md`
- API 根页:
- `docs/api/XCEngine/XCEngine.md`
- `docs/api/XCEditor/XCEditor.md`
- 模块页:
- `docs/api/XCEngine/{ModuleName}/{ModuleName}.md`
- `docs/api/XCEditor/{ModuleName}/{ModuleName}.md`
- 子模块页:
- `docs/api/XCEngine/{ModuleName}/{SubmoduleName}/{SubmoduleName}.md`
- `docs/api/XCEditor/{ModuleName}/{SubmoduleName}/{SubmoduleName}.md`
示例:
@@ -132,6 +150,8 @@ python -B docs/api/_tools/audit_api_docs.py
- `docs/api/XCEngine/Core/Asset/Asset.md`
- `docs/api/XCEngine/Rendering/Passes/Passes.md`
- `docs/api/XCEngine/Editor/Viewport/Viewport.md`
- `docs/api/XCEditor/Foundation/Foundation.md`
- `docs/api/XCEditor/Shell/Shell.md`
### 2. Header / source-backed 目录