llmdoc / docs / workflows
工作流
日常检索轻量且只读。知识改写则通过带校验、Git 边界与明确结果状态的显式工作流完成。
日常检索
- 选择一个入口:
tree、search、context --files、index或show。 - 让 llmdoc 收窄工作集。
- 用原生工具核对精确、实时的源码事实。
- 只有进入新子系统时,才再次应用检索门。
初始化
只有仓库不存在有效 V3 知识面时,才使用 init。它设计 domain 与 topic 边界、写入最小充分的 owner 文档,并把每个 first-class 子系统归类为“已文档化”“有意由源码重建”或阻塞缺口。
首批文档完成后,unborn 仓库先创建真实 HEAD commit;随后由 init-state 建立 ledger、validate 校验结构、Context Floor 探针验证路由,最后用 commit --all 完成 Git 收尾。
更新
update 对照代码 delta 与已授权的 reflection candidate,语义复核现有知识。仍然正确的文档会被标记为 verified unchanged,不会累积变更日志。
正文与路由必须独立复核:正文仍然正确时,description、code.paths 或 relations 仍可能需要修复。
update 信号产生的是复核集合,不是正文写入列表。
收敛
prune 删除重复、碎片与可低成本重建的库存。机械 report 只提供信号;真正的知识价值仍由 recorder 判断。
迁移
upgrade 只用于用户显式要求的 V2 到 V3 迁移。它绝不会隐式包含在 update 或 prune 中。
安全与完成
- 改写工作流需要确认,以及干净的 llmdoc 写入边界。
- 完成前必须校验;失败的写入通过 Git 回滚。
commit不会卷入用户 staged 的无关文件,并单独刷新有效性。- 工作流只报告一种结果:
success、no_change、dry_run、incomplete或failed。