Ensure Docs
交互式验证并补全文档覆盖
安装使用
复制下面这段提示词发给你的 AI（Claude / Cursor / TRAE / Codex / WorkBuddy 等），它会自动帮你完成安装：
帮我安装这个 AI Skill：Ensure Docs。 它的用途是：交互式验证并补全文档覆盖 完整的 Skill 内容见：https://321skill.com/skills/ensure-docs/raw/index.md 请读取该页面内容，如果是 SKILL.md 格式直接安装，如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接，AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
'请检查当前项目的文档覆盖率，并自动生成缺失的API文档'，它会扫描项目中的代码和现有文档，识别出未覆盖的模块，然后以问答形式询问是否生成每个缺失部分的文档，最终输出结构完整的Markdown文档，包含接口说明、参数、返回值示例等。
介绍
Ensure Docs 是一款专门解决文档覆盖不全问题的 AI 技能。开发团队常常面临文档滞后、缺失关键模块或覆盖率无法量化的问题，导致新成员上手困难、接口调用混乱、项目维护成本高。该技能自动扫描代码仓库中的源文件与现有文档，通过静态分析识别出未被文档覆盖的函数、类、API 端点等，并以交互式对话的方式引导用户逐项确认或一键生成缺失文档，确保技术文档与代码保持同步。
使用方式非常简单：在项目根目录下运行该技能，它会自动解析代码结构（支持 JavaScript/TypeScript、Python、Java、Go 等主流语言），生成覆盖报告。随后，AI 会以问答形式询问用户是否要为每个未覆盖的模块生成文档，用户可批量批准或单独精调。生成的文档支持 Markdown、OpenAPI、JSDoc、Sphinx 等多种格式，并且会智能匹配项目已有的文档风格。
适合文档工程师、后端开发者和全栈开发者。对于正在重构或快速迭代的项目，该技能能极大减少手动编写文档的时间，同时保证新功能上线时文档同步到位。建议在每次合并代码前或发布新版本时作为 CI 流程的一环执行，确保文档覆盖率始终达标。
使用前需确保项目已初始化版本控制（git），并安装了 Node.js 运行环境。对于大型单体仓库，建议分模块执行以避免扫描耗时过长。生成的文档仍需人工审查关键业务逻辑的准确性。
核心特点
与其他文档生成工具不同，Ensure Docs 先系统性验证文档覆盖率，再根据缺失情况交互式生成，而不是盲目补全所有内容，从而避免冗余文档并确保每份文档都有实际需求支撑。
注意事项
不适合需要高度创意或非结构化文档（如产品手册、营销文案）的场景，且对图形界面类项目（如设计稿）的文档无法自动生成。
常见问题
如何安装 Ensure Docs?
通过 npm 全局安装：npm install -g ensure-docs，或使用 npx ensure-docs 直接运行。
支持哪些编程语言?
目前支持 JavaScript/TypeScript、Python、Java、Go 等主流语言，更多语言正在扩展中。
给 AI 助手的安装指引
如果你的 AI 编程助手（Claude Code、Cursor、TRAE 等）能看到这个页面，把下面这段发给它即可自动完成安装：
请访问 https://321skill.com/skills/ensure-docs/raw/index.md 读取 Ensure Docs 的原始 Skill 定义（Markdown 格式），按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址：/skills/ensure-docs/raw/index.md（查看排版版本）