docs-generator

docs-generator 技能为技术文档提供了一种系统化的方法，专为 AI 优先的开发环境而设计。通过建立轻量级、层级化的文档结构，它确保了 AI 编码助手（如使用 AGENTS.md 或 agent.d 格式的助手）能在不消耗过多 Token 的情况下获得与上下文相关的资讯。此技能弥合了凌乱的代码库与现代 AI 开发工具结构化需求之间的差距。它专为软件架构师、后端工程师以及在 monorepo 或多套件专案中工作的开发者而设计，这些开发者需要为自己及其 AI 助手维护清晰、可操作的指导。

• 自动生成从根目录设置命令到模块级实现细节的层级化文档树。

• 支持多种输出格式，包括标准的 AGENTS.md、专用的 agent.d 配置以及可自定义的文档类型。

• 实现「最近优先」逻辑，确保 AI 助手优先读取与当前文件最接近的文档，最大限度减少噪声与幻觉。

• 通过搜索 Glob、文件路径映射及快速搜索终端命令提供即时索引 (JIT)，而非转储原始文件内容。

• 具备存储库分析功能，可检测技术栈、构建系统及主要目录结构，以实现量身定制的文档布局。

• 包含预检检查与「完成定义」(DoD) 模板，以确保团队提交与 PR 的一致性。

• 在执行前，请与使用者确认文档格式（AGENTS.md 或 agent.d）及目标范围（根目录或子文件夹），以保持专案规划的一致性。

• 根目录文档应保持轻量，理想情况下控制在 200 行以内，作为详细子文件夹文档的入口。

• 务必利用 JIT 索引功能来保持文档的可维护性；避免在文档中重复复制完整的代码块。

• 与使用 pnpm workspaces、Turborepo 或 Lerna 的专案搭配使用效果最佳，因为它可以自动发现这些结构模式。

• 利用「常见陷阱」与「模式与规范」部分来记录关于文件组织与团队特有反模式的经验知识。