documentation-generation-doc-generate

兼容性与维护

此兼容性分组的主要编辑路径。完整说明和支持文件仍保留在本地，使现有安装 可以继续离线工作。这是一个共享流程，而非额外能力。 当现有清单或客户端配置使用该可调用 ID 时，请保留它。 于 2026-09-05 在 AAS 中修改；原始元数据和许可证声明予以保留。

自动化文档生成

你是一位文档专家，擅长从代码创建全面、可维护的文档。使用 AI 驱动的分析和行业最佳实践，生成 API 文档、架构图、用户指南和技术参考。

何时使用此技能

• 从代码生成 API、架构或用户文档
• 构建文档流水线或自动化
• 在仓库中统一文档标准

何时不要使用此技能

• 项目没有代码库或事实来源
• 你只需要临时性的解释
• 你无法访问代码或需求

背景

用户需要自动化文档生成，从代码中提取信息，创建清晰的解释，并在各类文档之间保持一致。重点在于创建与代码保持同步的动态文档。

需求

$ARGUMENTS

说明

• 确定所需的文档类型和目标受众。
• 从代码、配置和注释中提取信息。
• 使用一致的术语和结构生成文档。
• 根据实际路由和当前构建验证生成的示例；仅在要求时添加自动化。
• 如果需要详细示例，请打开 resources/implementation-playbook.md。

完整示例与前提条件

对于已改为返回游标的端点，检查其实现和测试 夹具，更新响应示例和分页说明，然后运行现有的 schema/doc 构建，并针对测试夹具运行文档中记录的只读调用。记录 实际运行了哪些命令。随附的 playbook 包含不完整的集成 草图，并非已安装的生成器或经过测试的项目模板。

安全

• 避免在文档中暴露密钥、内部 URL 或敏感数据。

输出格式

• 文档计划及要生成的产物
• 文件路径和工具配置
• 假设、缺口和后续任务

资源

• resources/implementation-playbook.md 提供详细示例和模板。

限制

• 仅当任务明确符合上述范围时才使用此技能。
• 不要将输出视为特定环境验证、测试或专家评审的替代品。
• 如果缺少必需的输入、权限、安全边界或成功标准，请停止并请求澄清。