TokenRollAI/llmdoc

解决的问题

llmdoc 为 AI 编程助手（特别是 Claude Code 和 Codex）提供了一种结构化、文档驱动的工作流，以保持项目文档的最新状态。通过自动创建和同步 AI 自身可读可更新的文档骨架，防止 AI 丢失上下文或依赖过时信息。

工作原理

该系统使用专用的 llmdoc/ 目录存储项目知识。通过两个主要命令运行：

• /llmdoc:init：分析仓库，创建包含架构、概览和参考文档的文档骨架，并同步全局索引。
• /llmdoc:update：使用 git 提交历史（水印）检测自上次同步以来的变更。根据变更的规模和风险，自动选择 fast、analysis 或 full 更新模式，以更新相关文档并记录工作流程的反思。

通过生命周期系统管理上下文，区分「冷启动」（加载核心技能和必要组件）和「紧凑重入」（使用状态对象恢复任务，避免重新加载全部内容）。

适用人群

使用 Claude Code 或 Codex 的开发者，希望其 AI 助手能拥有持久、结构化的项目架构和实现意图记忆，而无需手动编写每次文档更新。

特色亮点

• 基于提交的同步：通过水印文件（sync.md）追踪变更，确保仅执行必要的更新。
• 自适应更新模式：根据变更的风险和作者自动选择 fast、analysis 或 full 更新路径。
• 编码化文档布局：将知识组织为特定类别，如 must/（冷启动上下文）、architecture/ 和 memory/（反思与决策）。
• 上下文预算管理：实现确定性代理（例如 24 KiB）以防止大型单体项目中上下文窗口溢出。
• 集成的代理角色：利用专用内部代理（调查者、工作者、记录者、反思者）收集证据并维护稳定文档。