选模型,从你要做的事开始
← 场景指南产品与工程

技术文档与开发者支持

从代码与已核验接口整理文档和可运行示例,结合资料检索回答开发者问题,并追踪代码变更对文档的影响。

准备什么

输入材料

代码、接口说明、示例、常见错误和产品版本。

得到什么

目标交付

API 文档、运行示例、排障指南和带引用的支持问答。

怎样一步步完成

把工作拆成可检查的环节,再选择模型和配套工具。

  1. 01

    对齐接口事实

    核对实际路由、参数、权限、返回值与错误信息。

  2. 02

    生成并执行示例

    让模型编写示例,在测试账号和环境运行后再写入文档。

  3. 03

    整理排障路径

    从真实问题提炼诊断步骤,注明版本和适用条件。

  4. 04

    建立更新与问答

    为文档构建检索,代码变更后检查相关章节和示例。

需要哪些模型能力

按实际环节组合使用,下面的目录会展示匹配其中一种或多种能力的候选。

查看匹配的模型

配套工具

接口测试环境代码与文档检索向量知识库

选型与交付检查

  • 模型写出的接口名称必须与实际实现或官方资料一致。
  • 示例通过语法检查不等于调用成功。
  • 支持问答保留版本和来源,资料缺失时不编造参数。

可以这样描述需求

根据真实接口编写并测试代码示例,建立文档向量知识库检索,生成带来源和版本说明的开发者支持问答。
带着这个需求继续选型

相关场景

全部场景