让 AI 不再按过期文档写代码:AgentLockDoc 开源了
AI 编程越来越强,但新的问题也越来越明显:AI 很容易读到过期 README、把计划当事实、搞不清当前阶段范围,或者改了代码却忘了同步文档。
我开源了 AgentLockDoc,一套为 AI-assisted development 设计的双语项目文档模板。它的目标不是让文档变多,而是让 AI 和人类始终站在同一个工程事实面上工作。
AgentLockDoc 的核心结构包括:
- AGENTS.md:AI 的项目总入口,告诉它先读什么、不要读什么
- SESSION.md:当前项目事实快照,只记录被路径或命令验证过的代码现实
- feature-registry:功能范围、阶段、状态、权威文档、代码入口和验证证据
- doc-code-map:从代码路径反查应该同步哪些权威文档
- conventions:统一 Status / Track / Risk / front-matter / 命名规则
- profiles:针对 Agent Platform、CLI Tool、Web SaaS、Library / SDK、Software Automation 的裁剪建议
- validate-docs:零依赖轻量自检脚本
它提供中文和英文两套完整模板:
- templates/zh-CN
- templates/en-US
使用方式很简单:
cp -R templates/zh-CN/. /path/to/your-project/ cd /path/to/your-project node scripts/validate-docs.mjs英文项目可以复制templates/en-US。
如果你正在用 Copilot、Claude、Cursor、Codex、Aider 或任何 coding agent 进行长期开发,AgentLockDoc 也许能帮你减少 AI 跨会话失忆和文档漂移的问题。
GitHub: https://github.com/yjfkpyu/AgentLock
gitee: https://gitee.com/corlink/agent-lock
如果这个项目对你有用,欢迎 star,让更多开发者看到它。
