depa-codument 0.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (117) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +262 -0
  3. package/package.json +63 -0
  4. package/src/cli/commands/archive.ts +519 -0
  5. package/src/cli/commands/decisions.ts +123 -0
  6. package/src/cli/commands/engineering.ts +105 -0
  7. package/src/cli/commands/init.ts +54 -0
  8. package/src/cli/commands/list.ts +73 -0
  9. package/src/cli/commands/modeling.ts +105 -0
  10. package/src/cli/commands/show.ts +238 -0
  11. package/src/cli/commands/status.ts +140 -0
  12. package/src/cli/commands/upgrade-track.ts +385 -0
  13. package/src/cli/commands/upgrade-workspace.ts +138 -0
  14. package/src/cli/commands/validate.ts +330 -0
  15. package/src/cli/engineering/config.ts +68 -0
  16. package/src/cli/engineering/lint.ts +58 -0
  17. package/src/cli/engineering/merge.ts +172 -0
  18. package/src/cli/engineering/registry.ts +230 -0
  19. package/src/cli/engineering/schema.ts +126 -0
  20. package/src/cli/engineering/validate.ts +286 -0
  21. package/src/cli/index.ts +136 -0
  22. package/src/cli/modeling/config.ts +68 -0
  23. package/src/cli/modeling/lint.ts +58 -0
  24. package/src/cli/modeling/merge.ts +172 -0
  25. package/src/cli/modeling/registry.ts +229 -0
  26. package/src/cli/modeling/schema.ts +160 -0
  27. package/src/cli/modeling/validate.ts +282 -0
  28. package/src/cli/utils/index.ts +941 -0
  29. package/src/cli/utils/install.ts +291 -0
  30. package/src/cli/utils/spec-xml.ts +673 -0
  31. package/src/cli/utils/track-time.ts +75 -0
  32. package/src/cli/utils/vfs.ts +102 -0
  33. package/src/templates/codument/README.md +59 -0
  34. package/src/templates/codument/attractors/product.md +17 -0
  35. package/src/templates/codument/attractors/project.md +10 -0
  36. package/src/templates/codument/backlog/README.md +33 -0
  37. package/src/templates/codument/config/attractor-profiles.xml +31 -0
  38. package/src/templates/codument/config/engineering.xml +22 -0
  39. package/src/templates/codument/config/modeling.xml +22 -0
  40. package/src/templates/codument/config/operation-hooks.xml +55 -0
  41. package/src/templates/codument/memory/README.md +13 -0
  42. package/src/templates/codument/missions/README.md +125 -0
  43. package/src/templates/codument/sop/README.md +14 -0
  44. package/src/templates/codument/std/AGENTS.md +82 -0
  45. package/src/templates/codument/std/attractors/depa-attractor.md +572 -0
  46. package/src/templates/codument/std/attractors/knowledge-tiers.md +128 -0
  47. package/src/templates/codument/std/attractors/model-driven-docs.md +293 -0
  48. package/src/templates/codument/std/attractors/project-memory.md +48 -0
  49. package/src/templates/codument/std/docs-impl-fractal/index.md +110 -0
  50. package/src/templates/codument/std/docs-modeling-fractal/index.md +156 -0
  51. package/src/templates/codument/std/kernel-pointer.md +19 -0
  52. package/src/templates/codument/std/operations/README.md +30 -0
  53. package/src/templates/codument/std/operations/_operation-spec.md +41 -0
  54. package/src/templates/codument/std/operations/archive-mission.md +66 -0
  55. package/src/templates/codument/std/operations/archive-track.md +238 -0
  56. package/src/templates/codument/std/operations/artifact-sync.md +172 -0
  57. package/src/templates/codument/std/operations/discuss-phase.md +214 -0
  58. package/src/templates/codument/std/operations/discuss.md +87 -0
  59. package/src/templates/codument/std/operations/docs-bootstrap.md +148 -0
  60. package/src/templates/codument/std/operations/gap-loop.md +301 -0
  61. package/src/templates/codument/std/operations/impl-mission.md +167 -0
  62. package/src/templates/codument/std/operations/impl-quick.md +79 -0
  63. package/src/templates/codument/std/operations/impl-track.md +537 -0
  64. package/src/templates/codument/std/operations/migrate.md +337 -0
  65. package/src/templates/codument/std/operations/plan-mission.md +230 -0
  66. package/src/templates/codument/std/operations/plan-track-wave.md +231 -0
  67. package/src/templates/codument/std/operations/plan-track.md +579 -0
  68. package/src/templates/codument/std/operations/revise-track.md +136 -0
  69. package/src/templates/codument/std/operations/validate.md +339 -0
  70. package/src/templates/codument/std/operations/verify.md +184 -0
  71. package/src/templates/codument/std/root-agents.md +39 -0
  72. package/src/templates/codument/std/sop/questioning.md +98 -0
  73. package/src/templates/codument/std/sop/tdd.md +26 -0
  74. package/src/templates/codument/std/sop/validation.md +25 -0
  75. package/src/templates/codument/std/sop/wave-exec.md +42 -0
  76. package/src/templates/codument/std/sop/workflow.md +35 -0
  77. package/src/templates/codument/std/spec/behavior-delta.md +36 -0
  78. package/src/templates/codument/std/spec/behavior-registry.md +42 -0
  79. package/src/templates/codument/std/spec/engineering-delta.md +68 -0
  80. package/src/templates/codument/std/spec/engineering-node-schema.md +86 -0
  81. package/src/templates/codument/std/spec/engineering-registry.md +82 -0
  82. package/src/templates/codument/std/spec/flow-notation.md +93 -0
  83. package/src/templates/codument/std/spec/folder-manifest.md +99 -0
  84. package/src/templates/codument/std/spec/mission-xml-spec.md +249 -0
  85. package/src/templates/codument/std/spec/modeling-delta.md +85 -0
  86. package/src/templates/codument/std/spec/modeling-node-schema.md +183 -0
  87. package/src/templates/codument/std/spec/modeling-registry.md +49 -0
  88. package/src/templates/codument/std/spec/track-xml-spec.md +272 -0
  89. package/src/templates/codument/std/spec/xnl-format.md +301 -0
  90. package/src/templates/codument/workflows/README.md +15 -0
  91. package/src/templates/manifest.ts +177 -0
  92. package/src/templates/skills/README.md +38 -0
  93. package/src/templates/skills/codument-archive/SKILL.md +17 -0
  94. package/src/templates/skills/codument-archive-mission/SKILL.md +17 -0
  95. package/src/templates/skills/codument-archive-track/SKILL.md +17 -0
  96. package/src/templates/skills/codument-artifact-sync/SKILL.md +17 -0
  97. package/src/templates/skills/codument-code-quality-score/SKILL.md +67 -0
  98. package/src/templates/skills/codument-decision-tree/SKILL.md +40 -0
  99. package/src/templates/skills/codument-discuss/SKILL.md +17 -0
  100. package/src/templates/skills/codument-discuss-phase/SKILL.md +17 -0
  101. package/src/templates/skills/codument-docs-bootstrap/SKILL.md +17 -0
  102. package/src/templates/skills/codument-gap-loop/SKILL.md +17 -0
  103. package/src/templates/skills/codument-impl-mission/SKILL.md +17 -0
  104. package/src/templates/skills/codument-impl-quick/SKILL.md +17 -0
  105. package/src/templates/skills/codument-impl-track/SKILL.md +17 -0
  106. package/src/templates/skills/codument-implement/SKILL.md +14 -0
  107. package/src/templates/skills/codument-migrate/SKILL.md +17 -0
  108. package/src/templates/skills/codument-modeling-engineering-e2e/SKILL.md +74 -0
  109. package/src/templates/skills/codument-plan-mission/SKILL.md +17 -0
  110. package/src/templates/skills/codument-plan-track/SKILL.md +17 -0
  111. package/src/templates/skills/codument-plan-track-wave/SKILL.md +17 -0
  112. package/src/templates/skills/codument-revise-track/SKILL.md +17 -0
  113. package/src/templates/skills/codument-track/SKILL.md +14 -0
  114. package/src/templates/skills/codument-validate/SKILL.md +17 -0
  115. package/src/templates/skills/codument-verify/SKILL.md +17 -0
  116. package/src/types/text-assets.d.ts +9 -0
  117. package/src/version.ts +1 -0
@@ -0,0 +1,82 @@
1
+ # Codument 使用指南(std/AGENTS.md)
2
+
3
+ AI 编程助手用 Codument 做行为驱动开发的**入口与路由**。本文件只做路由 + 速查;**怎么操作**的过程在 `std/sop/`,**格式规范**在 `std/spec/`,**各 skill** 在 `std/operations/`。init 后全部自包含于 `codument/`。
4
+
5
+ ## 何时打开本指南
6
+
7
+ - 提到 planning / proposal / track / mission(proposal、behavior、change、plan、track、mission、implement)
8
+ - 新增能力、破坏性变更、架构/模式调整、性能/安全工作
9
+ - 需求模糊、需要权威行为规范再动手
10
+ - 用户补充需求属于某进行中 track 范围
11
+
12
+ ## 路由表
13
+
14
+ | 你要做的事 | 去读 |
15
+ |---|---|
16
+ | 了解工作流程总纲 | `std/sop/workflow.md` |
17
+ | **一条信息该落哪层 / 何时晋升 / 冲突谁赢** | `std/attractors/knowledge-tiers.md`(分层 + 信息晋升 + 真源优先级) |
18
+ | 某标准文件夹"装什么" / 给目录补职责说明 | `std/spec/folder-manifest.md`(目录职责自描述 + 补齐机制) |
19
+ | 选下一个该做的任务(候选 + 自主度) | `backlog/README.md` |
20
+ | 规划跨多个 track 的路线 / mission | `missions/README.md`、`std/spec/mission-xml-spec.md` |
21
+ | 长期记忆(lessons/incidents/patterns) | `std/attractors/project-memory.md` + `memory/`(memory profile) |
22
+ | engineering/modeling 长期知识 registry 怎么写 | `std/spec/{modeling,engineering}-registry.md`、`std/spec/{modeling,engineering}-node-schema.md` |
23
+ | legacy docs/ 怎么写(modeling/impl 分形、frontmatter) | `std/attractors/model-driven-docs.md` → `std/docs-{modeling,impl}-fractal/index.md` |
24
+ | 怎么提问/确认/纠偏(协议) | `std/sop/questioning.md`、`std/sop/validation.md` |
25
+ | 执行套路(TDD / wave 调度 / gap-loop) | `std/sop/{tdd,wave-exec,gap-loop}.md` |
26
+ | track 文件(track.xml)格式 | `std/spec/track-xml-spec.md` |
27
+ | mission 文件(mission.xml)格式 | `std/spec/mission-xml-spec.md` |
28
+ | 流程标记块(flow notation)格式 | `std/spec/flow-notation.md` |
29
+ | 怎么写 behavior delta / behavior 登记表格式 | `std/spec/behavior-delta.md`、`std/spec/behavior-registry.md` |
30
+ | 怎么写 engineering delta / engineering 登记表格式 | `std/spec/engineering-delta.md`、`std/spec/engineering-registry.md` |
31
+ | 具体某个操作怎么做 | `std/operations/<name>.md`(索引见 `std/operations/README.md`) |
32
+ | 命令级 hook、attractor profile、能力开关 | `config/operation-hooks.xml`、`config/attractor-profiles.xml` |
33
+
34
+ ## 三阶段(详见 std/sop/workflow.md)
35
+
36
+ 0. **小改动**:`codument-impl-quick` → 读取 Codument 上下文后直接实现;若超出 quick 范围则转 track/mission。
37
+ 1. **创建 track 前讨论**:`codument-discuss` → 搜集上下文并分流到 quick / track / mission / blocked。
38
+ 2. **创建 track**:`codument-plan-track` → behavior delta(`behavior_deltas/`)+ proposal + `track.xml`(TaskSpace/Schedule/Hooks)。
39
+ 3. **实现**:`codument-discuss-phase` / `codument-plan-track-wave` / `codument-impl-track`,按需 `codument-gap-loop` / `codument-verify` / `codument-revise-track`。
40
+ 4. **归档**:`codument-archive-track` → 提升 behavior 进 `codument/behaviors/`、移入 `archive/`、按显式 hook 同步 artifact/docs。
41
+
42
+ mission 是更长周期的控制面对象:
43
+
44
+ 1. **创建 mission**:`codument-plan-mission` → `codument/missions/pending/<id>/mission.xml` + `proposal.md` + `design.md`。
45
+ 2. **执行 mission**:`codument-impl-mission` → 按 `mission.xml` DAG + MissionPlanner/Observer/Reconciler/Applier 控制论 actor loop 推进,允许受控重规划。
46
+ 3. **归档 mission**:`codument-archive-mission` → 移入 `codument/missions/archived/YYYY-MM-DD-<id>/`,按条件提升 decisions/memory。
47
+
48
+ ## 知识沉淀与晋升(务必,详见 std/attractors/knowledge-tiers.md)
49
+
50
+ codument 是 **track 中心**的:迭代记忆强,但 **owner registry(`codument/modeling`/`codument/engineering`)和 legacy owner docs(`docs/modeling`/`docs/impl`)的维护是弱环**,要刻意补强:
51
+
52
+ - **file-in/file-out**:重要输入/结论落文件,别只留 chat;按职责分类写回(见分层表)。
53
+ - **实时维护,不只归档**:澄清(discuss)期一旦某概念/行为/policy/架构**稳定**,**当轮就**收敛进 `codument/modeling` / `codument/engineering` 的 delta(或 legacy docs),不要拖到归档才补、也不要只留在 proposal。
54
+ - **晋升阶梯**:track → `behaviors/`(行为,归档必做)/ `codument/modeling`(结构真源)/ `codument/engineering`(工程知识真源)/ `decisions/`(承重决策)/ `memory/`(复用教训);`memory` 中**反复复发**的再固化为 sop/skill/check。触发条件见 knowledge-tiers.md §5。
55
+ - **新建目录自带职责**:在 docs/ 下新建文件夹时,按 `std/spec/folder-manifest.md` 给它写"目录职责"块(或跑补齐)。
56
+
57
+ ## skill 入口(优先用 skill)
58
+
59
+ ```
60
+ 请使用 codument-plan-track skill, 创建 track: <track-id>
61
+ 请使用 codument-discuss skill, 讨论尚未确定 quick/track/mission 的需求
62
+ 请使用 codument-impl-quick skill, 快速实现小改动
63
+ 请使用 codument-discuss-phase / codument-plan-track-wave / codument-impl-track skill, 处理 track: <track-id>
64
+ 请使用 codument-gap-loop / codument-verify / codument-revise-track skill, 校验/验证/修订 track: <track-id>
65
+ 请使用 codument-archive-track / codument-validate skill
66
+ 请使用 codument-plan-mission / codument-impl-mission / codument-archive-mission skill
67
+ 请使用 codument-docs-bootstrap / codument-artifact-sync / codument-migrate skill
68
+ ```
69
+
70
+ ## CLI 速查
71
+
72
+ ```bash
73
+ codument list [--behaviors] # 列活跃 track / 行为登记表
74
+ codument show [item] [--json]
75
+ codument validate [item] [--strict]
76
+ codument archive <track-id>
77
+ codument modeling validate|lint
78
+ codument engineering validate|lint
79
+ codument init [path] / upgrade-workspace / upgrade-track <id> / status
80
+ ```
81
+
82
+ > 外部 CLI 回退:若提示词要求运行 `codument validate ...` 但系统无 `codument` 命令,跳过该步并明确说明已跳过(不阻塞工作流)。详见 `std/sop/workflow.md`。