mirror of
https://github.com/motajs/template.git
synced 2026-10-29 20:30:20 +08:00
docs(10): sync phase 10 progress after advanced II
This commit is contained in:
parent
4f31be1396
commit
7cfb672b2a
@ -547,14 +547,14 @@ Phases execute in numeric order: 1 → 2 → 3 → 4 → 5 → 6 → 7 → 8 →
|
||||
| 7. 数据端缺陷修复 | 15/16 | Complete（07-16 superseded） | - |
|
||||
| 8. 测试重构与接口对齐 | 11/11 | Complete | 2026-10-08 |
|
||||
| 9. 最小浏览器可运行版本 | 15/16 | In Progress| |
|
||||
| 10. 文档重构 | 17/27 | In Progress | - |
|
||||
| 10. 文档重构 | 24/27 | In Progress | - |
|
||||
|
||||
### Phase 10: 文档重构
|
||||
|
||||
**Goal:** 重构过老、结构不佳、新人难懂的项目文档，面向多背景读者（完全新手 / 不懂代码的作者 / 有基础的作者 / AI Agent）提供分层指南。本阶段采用「伞阶段 + 增量派发」：每次只规划执行一个已派发的具体小任务。**第一批已派发 = 中级教程（`docs/intermediate/`，24 篇中文 markdown）+ 在 VitePress 站点注册它们 + 旧内容清空（D-04 并入本批）**（D-01..D-44）。**第二批已派发 = 高级教程 I（`docs/advanced/`，7 篇数据端文档）+ 站点注册 + 独立读者人格审阅 + 用户主导修订循环**（D-53..D-57）。**第三批已规划（暂定，待用户批准后执行）= 高级教程 II「深入定制」（`docs/advanced/ii/`，9 篇数据端文档）+ 站点注册 + 独立读者人格审阅 + 用户主导修订循环**（D-67）。
|
||||
**Requirements**: （无专属需求 ID；以 `10-CONTEXT.md` 的 D-01..D-67 为需求基线，验收锚在 D-09：用户人工审阅 + 链接全部有效 + 构建通过）
|
||||
**Goal:** 重构过老、结构不佳、新人难懂的项目文档，面向多背景读者（完全新手 / 不懂代码的作者 / 有基础的作者 / AI Agent）提供分层指南。本阶段采用「伞阶段 + 增量派发」：每次只规划执行一个已派发的具体小任务。**第一批已派发 = 中级教程（`docs/intermediate/`，24 篇中文 markdown）+ 在 VitePress 站点注册它们 + 旧内容清空（D-04 并入本批）**（D-01..D-44）。**第二批已派发 = 高级教程 I（`docs/advanced/`，7 篇数据端文档）+ 站点注册 + 独立读者人格审阅 + 用户主导修订循环**（D-53..D-57）。**第三批已完成 = 高级教程 II「深入定制」（`docs/advanced/ii/`，10 篇数据端文档）+ 站点注册 + 独立读者人格审阅 + 用户主导修订循环**（D-67，2026-10-23 收尾）。
|
||||
**Requirements**: （无专属需求 ID；以 `10-CONTEXT.md` 的 D-01..D-74 为需求基线，验收锚在 D-09：用户人工审阅 + 链接全部有效 + 构建通过）
|
||||
**Depends on:** Phase 9
|
||||
**Plans:** 17/27 completed（第一批：中级教程 24 篇 + 站点注册 + D-09 复审修订；第二批：高级 I 7 篇 + 注册 + 读者审阅 + 用户修订循环；第三批：高级 II 9 篇 + 注册 + 读者审阅 + 用户修订循环）。**未完成 10 个**：`10-06`（中级全批验收）、`10-11`（中级读者审阅）、`10-12`（中级最终验收）——其范围已被后续 D-09 修订与高级 I 期间的最终状态覆盖，缺独立 SUMMARY，待补跑或并入后续验收；`10-21`..`10-27`（高级 II）为暂定规划，待用户确认文件名、侧边栏分组名后执行。
|
||||
**Plans:** 24/27 completed（第一批：中级教程 24 篇 + 站点注册 + D-09 复审修订；第二批：高级 I 7 篇 + 注册 + 读者审阅 + 用户修订循环；第三批：高级 II 10 篇 + 注册 + 读者审阅 + 用户修订循环）。**未完成 3 个**：`10-06`（中级全批验收）、`10-11`（中级读者审阅）、`10-12`（中级最终验收）——其范围已被后续 D-09 修订与高级 I/II 期间的最终状态覆盖，缺独立 SUMMARY，待补跑或并入后续验收。
|
||||
|
||||
Plans:
|
||||
- [x] 10-01-PLAN.md — Wave 0：旧内容清空 + 站点注册（删除 `docs/guide`、`docs/dev`、`docs/logger`、`docs/api` 与首页 `docs/index.md`；清理 `config.ts` 旧 nav/sidebar 键并解除 apiSidebar/api 依赖；`api.ts` 加缺失目录守卫；新增 nav 入口 + `sidebar['/intermediate/']` 4 组/24 条；报告并等待 checkpoint）
|
||||
@ -577,16 +577,16 @@ Plans:
|
||||
- [x] 10-18-PLAN.md — 高级 I 导览 + 站点注册（`docs/advanced/index.md`、`config.ts` 的 nav / sidebar、六篇互链收口 + 全量构建）
|
||||
- [x] 10-19-PLAN.md — 高级 I 独立读者人格审阅（不同于中级人格）→ 问题清单 → 迭代修正（≤3 轮）→ 复审清零
|
||||
- [x] 10-20-PLAN.md — 高级 I 用户主导修订循环 → 用户确认 → 最终格式 / 构建 / SUMMARY 收尾
|
||||
- [ ] 10-21-PLAN.md — 高级 II 基础篇：自定义范围对象（`IRange` / 参数 / 绑定宿主）+ 静态与动态图块（含点事件与图块事件）
|
||||
- [ ] 10-22-PLAN.md — 高级 II 系统篇：勇士的装备系统（实例仓 / 修饰器 / 排序器 / `compareEquip` / 装备事件）+ 自定义录像指令（指令码 / `IReplayCommand` / 主动被动 / 沙盒）
|
||||
- [ ] 10-23-PLAN.md — 高级 II 流程与属性篇：自动寻路（只讲流程）+ 新增勇士属性（攻速 / 护甲接入伤害计算）
|
||||
- [ ] 10-24-PLAN.md — 高级 II 怪物篇：新增怪物属性 + 怪物上下文与战斗深入（buildup / 优先级 / 脏标记 / 伤害系统）
|
||||
- [ ] 10-25-PLAN.md — 高级 II 导览 + 侧边栏注册（`/advanced/ii/` 九篇、分组名待用户确认）+ 互链与全量构建
|
||||
- [ ] 10-26-PLAN.md — 高级 II 独立读者人格审阅（高代码能力人格，不同于高级 I）→ 问题清单 → 迭代修正（≤3 轮）→ 复审清零
|
||||
- [ ] 10-27-PLAN.md — 高级 II 用户主导修订循环 → 用户确认 → 最终格式 / 构建 / SUMMARY 收尾
|
||||
- [x] 10-21-PLAN.md — 高级 II 基础篇：自定义范围对象（`IRange` / 参数 / 绑定宿主）+ 静态与动态图块（含点事件与图块事件）
|
||||
- [x] 10-22-PLAN.md — 高级 II 系统篇：勇士的装备系统（实例仓 / 修饰器 / 排序器 / `compareEquip` / 装备事件）+ 自定义录像指令（指令码 / `IReplayCommand` / 主动被动 / 沙盒）
|
||||
- [x] 10-23-PLAN.md — 高级 II 流程与属性篇：自动寻路（只讲流程）+ 新增勇士属性（攻速 / 护甲接入伤害计算）
|
||||
- [x] 10-24-PLAN.md — 高级 II 怪物篇：新增怪物属性 + 怪物上下文与战斗深入（buildup / 优先级 / 脏标记 / 伤害系统）
|
||||
- [x] 10-25-PLAN.md — 高级 II 导览 + 侧边栏注册（`/advanced/ii/` 九篇、分组名待用户确认）+ 互链与全量构建
|
||||
- [x] 10-26-PLAN.md — 高级 II 独立读者人格审阅（高代码能力人格，不同于高级 I）→ 问题清单 → 迭代修正（≤3 轮）→ 复审清零
|
||||
- [x] 10-27-PLAN.md — 高级 II 用户主导修订循环 → 用户确认 → 最终格式 / 构建 / SUMMARY 收尾
|
||||
|
||||
**说明：** 每篇中级教程遵循 `10-CONTEXT.md` D-21..D-44 的逐篇要点与阅读顺序（4/8/9/3）。**旧内容删除已并入本批（D-04，Wave 0 / 10-01）**：删除 `docs/guide/*`、`docs/dev/*`、`docs/logger/*`、`docs/api/*` 与首页 `docs/index.md`，并清理 `docs/.vitepress/config.ts` 的旧 `nav`/`sidebar` 键。文档改动为 `docs/intermediate/*.md`（新增）、`docs/.vitepress/config.ts` 与 `docs/.vitepress/api.ts`（缺失目录守卫，保留按包生成机制）。构建命令 `cmd /c "pnpm exec tsx docs/.vitepress/init.ts && pnpm docs:build"`；`init.ts` 在 `docs/api/` 缺失时安全跳过。本机 PowerShell 禁止 `pnpm.ps1`，命令经 `cmd /c "..."` 执行。
|
||||
|
||||
**高级 I 说明：** 第二批（10-13..10-20）只写**数据端**内容，不含渲染端；七篇文件名与侧边栏显示名以各计划 Task 0 的用户确认为准（D-13）。指向高级 II / III 的内容一律使用代码 span 或 HTML 注释占位，不写真实链接（D-47）。每篇保留「怎么验证」小节，并按 D-48 六步 / D-49 改内置优先 / D-50 模板独立 / D-51 落点与副作用 / D-52 加粗边界执行。构建命令同上；10-18 负责站点注册与全量链接收口，10-19 / 10-20 分别执行独立读者人格审阅与用户主导修订循环，**用户明确确认后方可收尾**（D-46 第 2 阶段 / D-57）。
|
||||
|
||||
**高级 II 说明（暂定）：** 第三批（10-21..10-27）按 D-67 定位为「深入定制」难度层，只写**数据端**内容；拟建 `docs/advanced/ii/` 九篇（导览 + 8 个主题），文件名与侧边栏分组名以各计划 Task 0 的用户确认为准（D-13），当前建议分组名为「高级 II · 深入定制」。写作按 D-59 库文档风格（不套用中级六步）、D-60 简洁、D-61 主干与边界分离、D-62 代码块完整、D-63 模板顺序、D-64 只在需实现接口时给模板、D-65 注释充足、D-66 并列功能分开示例；不写中级特有的「改内置还是自己写」提示（D-58），新增系统优先插件（D-55）。渲染端、编辑器、状态栏与怪物图鉴按 D-47 用非断链占位；高级 III 只用代码 span 或 `TODO(advanced-III)` 注释。10-25 负责导览、站点注册与全量链接收口；10-26 使用比高级 I 更高的独立读者人格（能读懂引擎源码、想做系统级定制但不熟悉具体系统实现），10-27 执行用户主导修订循环，**用户明确确认后方可收尾**（D-46 第 2 阶段）。构建命令同上。
|
||||
**高级 II 说明（已完成）：** 第三批（10-21..10-27）按 D-67 / D-53 定位为「深入定制」**难度层**（难度标签，非领域分类），只写**数据端**内容；已建 `docs/advanced/ii/` **10 篇**（导览 + 8 个主题 + 点事件与图块事件）。写作按 D-59 库文档风格、D-60 简洁、D-61 主干与边界分离、D-62/D-70 代码块完整、D-63 模板顺序、D-64 只在需实现接口时给模板、D-65 注释充足、D-66 并列功能分开示例、D-69 内部实现章节后置；读者水平按 D-68（已理解绝大多数常用语法，认真阅读后能读明白一部分简单与中等复杂度系统，不预设资深开发者）。侧边栏分组名「高级 II · 深入定制」。渲染端 / 编辑器 / 状态栏 / 怪物图鉴按 D-47 非断链占位；高级 III 只用代码 span 或 `TODO(advanced-III)` 注释。10-25 负责导览与站点注册，10-26 执行独立读者审阅，10-27 执行用户主导修订循环，**用户已明确确认**（D-46 第 2 阶段）并于 2026-10-23 收尾。构建命令同上。
|
||||
|
||||
@ -4,16 +4,16 @@ milestone: v1.0
|
||||
current_phase: 10
|
||||
current_phase_name: 文档重构
|
||||
status: executing
|
||||
stopped_at: Phase 10 进行中：中级教程 24 篇 + 高级 I 7 篇已收尾；10-06/10-11/10-12 待补
|
||||
last_updated: "2026-10-20T00:00:00.000Z"
|
||||
last_activity: 2026-10-20
|
||||
last_activity_desc: 高级 I（docs/advanced 7 篇）完成并经用户确认收尾
|
||||
stopped_at: Phase 10 进行中：中级 24 篇 + 高级 I 7 篇 + 高级 II 10 篇已收尾；10-06/10-11/10-12 待补
|
||||
last_updated: "2026-10-23T00:00:00.000Z"
|
||||
last_activity: 2026-10-23
|
||||
last_activity_desc: 高级 II（docs/advanced/ii 10 篇）完成并经用户确认收尾
|
||||
state_head: dbbcf533dce2f22078a82d26817f36b85865da62
|
||||
progress:
|
||||
total_phases: 10
|
||||
completed_phases: 3
|
||||
total_plans: 122
|
||||
completed_plans: 114
|
||||
total_plans: 129
|
||||
completed_plans: 121
|
||||
milestone_name: milestone
|
||||
---
|
||||
|
||||
@ -29,11 +29,11 @@ See: .planning/PROJECT.md (updated 2026-09-17)
|
||||
## Current Position
|
||||
|
||||
Phase: 10 (文档重构) — IN PROGRESS
|
||||
Plan: 第一批（中级教程 24 篇）与第二批（高级 I 7 篇）已收尾；10-06 / 10-11 / 10-12 待补
|
||||
Plan: 第一批（中级 24 篇）、第二批（高级 I 7 篇）、第三批（高级 II 10 篇）已收尾；10-06 / 10-11 / 10-12 待补
|
||||
Status: In Progress
|
||||
Last activity: 2026-10-20 — 高级 I 完成并经用户确认收尾
|
||||
Last activity: 2026-10-23 — 高级 II 完成并经用户确认收尾
|
||||
|
||||
Progress: Phase 10 · 17/20 plans（中级 + 高级 I 已收尾；总览 / 初级 / 高级 II·III / API / Agent 参考仍待推进）
|
||||
Progress: Phase 10 · 24/27 plans（中级 + 高级 I + 高级 II 已收尾；总览 / 初级 / 高级 III / API / Agent 参考仍待推进）
|
||||
|
||||
## Performance Metrics
|
||||
|
||||
@ -266,7 +266,7 @@ Recent decisions affecting current work:
|
||||
- Phases 4/5/6 marked obsolete (2026-10-08): 渲染适配与双布局 / Legacy 移植 / 单元测试 的原规划不再合理，由 Phase 9 承接；仅文本标注，未删除阶段目录、已执行 PLAN/SUMMARY 或代码
|
||||
- Phase 9 added (2026-10-08): 最小浏览器可运行版本（在已完成且 Node 可运行/回放验证的数据端之上完成渲染端框架，并验证可在浏览器上运行）；Depends on Phase 8
|
||||
- Phase 10 added (2026-10-14): 文档重构（重构过老、结构不佳、新人难懂的项目文档，面向新人/不懂代码的作者/有基础作者等多背景读者提供分层指南，并专门为 AI Agent 编写参考文档）；Depends on Phase 9
|
||||
- Phase 10 第一批（中级教程 24 篇 + 旧内容清空 + 站点注册 + D-09 修订 + 读者/用户修订循环）已完成并收尾（2026-10-20）；第二批（高级 I 7 篇 + 站点注册 + 独立读者审阅 + 用户 6 轮修订）已完成并经用户确认收尾（2026-10-20）。遗留 `10-06` / `10-11` / `10-12` 缺独立 SUMMARY，其范围已被后续修订覆盖
|
||||
- Phase 10 第一批（中级教程 24 篇 + 旧内容清空 + 站点注册 + D-09 修订 + 读者/用户修订循环）已完成并收尾（2026-10-20）；第二批（高级 I 7 篇 + 站点注册 + 独立读者审阅 + 用户 6 轮修订）已完成并经用户确认收尾（2026-10-20）；第三批（高级 II 10 篇 + 站点注册 + 独立读者审阅 + 用户 3 轮修订）已完成并经用户确认收尾（2026-10-23）。遗留 `10-06` / `10-11` / `10-12` 缺独立 SUMMARY，其范围已被后续修订覆盖
|
||||
|
||||
### Pending Todos
|
||||
|
||||
|
||||
@ -57,7 +57,7 @@
|
||||
"next": {
|
||||
"command": "/gsd:progress --next",
|
||||
"label": "Advance to the next step",
|
||||
"reason": "Phase 10 of 10 · in progress（中级 + 高级 I 已收尾）"
|
||||
"reason": "Phase 10 of 10 · in progress（中级 + 高级 I + 高级 II 已收尾）"
|
||||
},
|
||||
"updated_at": "2026-10-20T00:00:00.000Z"
|
||||
"updated_at": "2026-10-23T00:00:00.000Z"
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user