用途:Auto-Docs 用于为 AI 编程代理自动生成并维护结构化项目文档,让不同 AI 工具都能读取同一套项目说明。
主要能力:以 .ai/docs/ 为唯一事实来源(TOON 加 Markdown),派生出多种工具格式,包括通用 AGENTS.md(供 Codex、Gemini CLI、Copilot、Cursor、Windsurf、Aider 等 20 多个工具读取)、CLAUDE.md(含 @ 导入)、.cursor/rules/auto-docs.mdc、.github/copilot-instructions.md。文档采用三层渐进披露:L1 索引 index.toon,L2 各功能详情文件,L3 架构、决策、依赖等横切文档。
使用方式:默认生成模式,在无 .ai/docs/ 的项目中运行 /auto-docs;更新模式运行 /auto-docs update,对比代码变化后更新文档并重新派生各工具文件。生成流程分发现、生成、分发、校验、报告五阶段。校验需先安装依赖 npm install --prefix <skill-path>/scripts,再运行 node <skill-path>/scripts/validate.mjs .ai/docs。
适用场景:为已有代码库补充 AI 可读文档、在重构或依赖变更后同步文档、统一多款 AI 编程工具的项目上下文。
限制:文档只记录可从代码库验证的内容,路径须真实存在,TOON 计数须与实际行数一致;AGENTS.md 建议控制在 4000 tokens 以内。具体收费、价格与平台支持情况暂未提供。