让 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,让更多开发者看到它。

相关推荐
Elastic 中国社区官方博客5 小时前
搜索倍增器:推动收入、生产力和 AI 实现规模化
大数据·数据库·人工智能·elasticsearch·搜索引擎·ai·全文检索
wjkjpcba5 小时前
机器人控制板PCBA怎么加工?从SMT贴片到BGA焊接解析机器人电子制造工艺
大数据·人工智能
青 春 记 忆6 小时前
Dify Docker Compose 通用无损升级指南:从备份、双版本预演到切换与回滚
运维·人工智能·python·docker·容器
小猪妈咪爱学法6 小时前
欧盟最新发布《AI数字综合法案(Digital Omnibus‑on‑AI,AI综合修订法案)
人工智能·网络安全
ZGIAI6 小时前
ZGI Workflow 变量池:接住节点输出
人工智能·架构
梵构广告6 小时前
提升品牌识别度有哪些方法?
人工智能
ZGIAI6 小时前
ZGI 记忆隔离:多人共用不串号
人工智能·架构
星栈独行7 小时前
决定 Agent 交付下限的「操作系统」:Harness 六层架构拆解
人工智能·架构
AKAMAI7 小时前
实时可观测性:Akamai Cloud Pulse 警报功能正式发布
人工智能·云计算
Capricorn19887 小时前
解决全网抄 Karpathy 导致的 LLM Wiki 污染?基于知芽 Notebook Skill 的 raw/ 笔记法排障指南
大数据·论文阅读·人工智能·笔记·论文笔记