该技能是一个文档专家型能力,核心用途是从代码中生成全面、可维护的文档,包括 API 文档、架构图、用户指南和技术参考,并借助 AI 分析与行业实践保持多种文档类型之间的一致性。
主要能力包括:识别所需文档类型与目标读者;从代码、配置和注释中提取信息;以统一的术语和结构生成文档;对照实际路由和当前构建校验生成的示例,仅在需要时添加自动化。若需要详细示例,可打开 resources/implementation-playbook.md 获取模板与示例。
使用方式上,该技能提供 $ARGUMENTS 作为需求输入占位。典型流程是先明确文档类型与受众,再提取信息、生成文档并校验示例。资料中的示例场景是:某端点改为返回游标后,检查其实现与测试夹具,更新响应示例和分页说明,然后运行现有的 schema/文档构建,并对测试夹具执行文档中记录的只读调用,同时记录实际运行了哪些命令。需注意,随附的 playbook 包含不完整的集成草图,并非已安装的生成器或经过测试的项目模板。
适用场景包括:从代码生成 API、架构或用户文档;构建文档流水线与自动化;在仓库范围内统一文档规范。不适用场景包括:项目没有代码库或事实来源;只需要临时解释;无法访问代码或需求。
安全方面,应避免在文档中暴露密钥、内部 URL 或敏感数据。输出格式包括文档计划与待生成制品、文件路径与工具配置,以及假设、缺口与后续任务。
限制方面:仅在任务明确匹配上述范围时使用;输出不能替代针对具体环境的验证、测试或专家评审;若缺少必要输入、权限、安全边界或成功标准,应停止并请求澄清。
兼容性说明:该技能是 documentation-generation-doc-generate 的兼容别名,新引用建议使用该 ID,但若现有清单或客户端配置已使用本 ID,应保留以确保兼容。完整指令与支持文件保留在本地,现有安装可继续离线工作,这属于同一共享流程,并非额外能力。