RAG知识库API文档生成清晰框架提示词

角色定义与任务定位

请以一名资深技术文档架构师兼API产品设计师的身份，运用本提示词方案。你的核心目标是：基于给定的RAG知识库内容，系统性地生成一份结构清晰、描述准确、风格统一且便于开发者直接使用的API接口文档，将非结构化的知识转化为标准化的技术资产。

适用场景

• 为内部或公开的RAG服务构建标准API参考文档。
• 将零散的接口说明、参数定义、返回示例整合为体系化文档。
• 为新接入的开发者提供快速上手的指引和代码示例。
• 在技术产品发布或更新时，同步生成或刷新配套API文档。

核心提示词

可直接复制使用的提示词主干：

• 生成一份专业的RAG知识库API文档，包含概述、认证、端点列表、请求/响应示例、状态码和错误处理。
• 为 `/query` 端点撰写详细说明，包括：功能描述、HTTP方法、请求头、请求体参数（如：query_text, top_k, score_threshold）、成功与错误的JSON响应示例。
• 解释RAG API的核心参数 `top_k` 和 `score_threshold` 对检索结果的影响，并提供参数选择建议。
• 编写一个完整的“快速开始”指南，包含获取API密钥、基础调用代码示例（Python/curl）和首次查询的步骤。

风格方向

• 专业严谨：采用技术文档的客观、准确语调，避免营销化或模糊表述。
• 用户友好：以开发者视角行文，假设读者具备基础编程知识，但不过度熟悉你的系统。
• 结构化视觉：在内容编排上体现清晰的层级，通过标题、列表、代码块等元素形成视觉节奏，便于扫描阅读。
• 一致术语：全文固定使用“检索增强生成”、“知识片段”、“置信度分数”等关键术语，保持统一。

构图建议（信息架构）

• 顶部框架：文档标题 + 版本号 + 简短服务概述（1-2句话说明核心价值）。
• 左侧导航（或文档内大纲）：按“概述 → 快速开始 → 认证 → API端点详解 → 错误代码 → 常见问题”顺序组织。
• 内容主体：每个端点描述采用固定板块：端点路径与方法、功能描述、请求参数表（名称、类型、必选、说明）、响应字段表、实际调用示例。
• 底部收尾：包含更新日志、获取支持和相关资源链接。

细节强化

• 代码高亮：所有请求与响应示例必须格式化为代码块，并标注语言类型（如json, python, shell）。
• 参数表格化：使用表格清晰对比参数属性，表格列包括：参数名、位置（query/body/header）、数据类型、是否必填、默认值、描述。
• 情境化示例：提供正反示例，例如一个成功的知识查询请求/响应，和一个因`score_threshold`过高而返回空列表的响应。
• 关键提示：在重要概念（如异步处理、速率限制）旁添加“注意”或“提示”框，进行强调说明。
• 链接与锚点：在文档内部相互引用，如从错误代码链接回相关端点的错误处理部分。

使用建议

• 将“核心提示词”中的句子作为生成任务的直接输入或分段任务指令。
• 在实际生成时，将 `[]` 中的占位符替换为RAG知识库的具体信息，如 `[您的API密钥]`、`[基础URL]`。
• 可先使用提示词生成文档骨架，再针对每个端点进行迭代细化，补充更具体的业务逻辑描述。
• 生成后，务必进行“开发者体验”复查：模拟一个新用户，仅凭此文档能否完成一次成功的API调用。
• 本框架也适用于生成API开发手册、SDK集成指南等衍生文档，只需调整提示词中的核心对象即可。