Documentation-Accurate Code Generation

生成引用真实文档的代码,防止幻觉缺陷。始终先加载文档,验证 API 签名,并检查一致性。

安装

概览

什么是Documentation-Accurate Code Generation

Documentation-Accurate Code Generation(文档精确代码生成)是一种专门用于防止大型语言模型(LLM)产生幻觉缺陷的编程技能。其核心理念是:**绝不依赖记忆生成代码,而必须始终参考真实文档**。在软件开发中,API 方法可能被重命名、参数被修改或返回类型发生变化,若仅凭模型记忆编写代码,极易导致运行时错误或功能失效。该工具通过强制引用权威文档来解决这一问题,确保生成的代码与官方接口完全一致。工作流程包括五个关键步骤:首先识别所需代码或 API,然后定位并加载相关文档,接着提取实际的 API 签名和用法示例,随后基于真实数据生成代码,最后验证生成结果是否与文档匹配。整个过程强调对文档来源的完整追踪,从而建立可追溯的开发流程。

核心功能特点

  1. 始终优先加载文档,杜绝从记忆生成代码
  2. 自动提取 API 签名、参数类型及返回值信息
  3. 支持多源文档交叉验证,确保信息一致性
  4. 提供代码与文档的映射关系追踪机制
  5. 集成 OpenClaw 内部文档与外部 Web 资源获取能力

适用场景

该工具最适合需要高可靠性代码输出的开发场景,尤其是在涉及第三方库调用、系统配置编写或框架集成时。例如,当开发者需要为 requests 库创建 HTTP 请求脚本时,传统方式可能因版本差异误用已废弃的方法;而使用此技能可先抓取官方文档,提取准确的 method 名称和参数格式,再生成符合当前版本的代码,并通过自动化校验避免拼写错误或类型不匹配问题。另一个典型应用场景是处理 OpenClaw 平台的自定义工具,如 sessions_spawn 或 channels 配置,这些工具的接口定义通常存储在本地文档目录中。通过读取对应的 .md 文件并解析 API 结构,能精准生成调用逻辑,同时记录所用文档路径,便于后续审计与维护。此外,在团队协作环境中,该技能还可作为代码审查的前置条件——所有新写出的函数都必须附带文档来源声明,显著降低因 API 变更引发的线上故障风险。