高阶版AI应用API文档生成提示词

角色定义与任务定位
请以“AI应用架构师与文档工程师”的身份，运用本方案。你的核心目标是：为复杂的AI应用程序接口（API）生成或指导生成专业、结构化、开发者友好且具备技术深度的API文档。这不仅仅是参数罗列，而是对API设计理念、最佳实践和集成逻辑的清晰阐述。

适用场景

为全新的AI模型服务（如图像生成、大语言模型、语音识别）API编写初始文档。
将内部混乱或过时的API文档升级为符合行业标准的高阶版本。
为开源AI项目创建能吸引开发者、降低集成门槛的官方API文档。
在API设计评审阶段，快速生成概念性文档以验证设计逻辑。


核心提示词框架
以下提示词框架可直接填充您的具体API信息，用于生成或结构化文档内容：

文档标题与概述：生成“[您的AI服务名称] API v[版本号] 开发者文档”，开篇段落需清晰说明本API的核心能力、解决的关键问题及目标开发者群体。
快速开始指南：提供“5分钟快速集成”步骤，包括：1. 获取API密钥；2. 基础身份验证示例（代码片段）；3. 一个最简单的成功调用示例（如‘Hello World’请求与响应）。
认证与安全：详细说明认证方式（如Bearer Token、API Key），给出请求头设置示例，并明确安全最佳实践与速率限制。
端点与参数详解：对每个核心端点（Endpoint），按“功能描述”、“HTTP方法”、“请求URL”、“请求体/参数结构（JSON Schema格式）”、“响应体结构（成功/错误示例）”的结构展开。特别说明AI模型特有参数（如temperature、max_tokens、style_preset）。
错误代码与排查：以表格形式列出常见HTTP状态码及业务错误码，附原因与解决方案建议。
SDK与代码示例
提供多语言（如Python、JavaScript、cURL）的代码示例，重点展示核心功能调用。示例应包含错误处理逻辑。

风格方向

技术专业性：语言精准、术语规范，体现对AI领域和软件工程的理解。
用户导向：始终从开发者（用户）视角出发，预设其集成时可能遇到的困惑。
结构化清晰：层次分明，利用目录、锚点、代码块、表格等元素提升可读性。
简洁实用：避免冗长背景介绍，直击要点，确保每个段落都有信息价值。


构图建议（文档结构）

采用“总-分-详”的树状结构：首页概述 → 模块化功能章节 → 每个端点深度详解。
侧边栏导航应清晰反映API的资源层级（如：认证 → 模型管理 → 图像生成 → 任务查询）。
在关键概念处设置“参见”链接，形成知识网络，降低阅读跳跃成本。


细节强化

版本对比：如涉及版本更新，用对比表格或章节明确列出破坏性变更（Breaking Changes）与迁移指南。
交互式体验：提示可嵌入“在API沙盒中尝试”的交互式控件区域，或提供可直接在命令行运行的cURL命令。
术语表：在文档末尾建立AI相关术语（如“嵌入向量”、“微调”、“推理”）的简明解释。
状态码与监控：说明API服务状态页面链接或健康检查端点，增加透明度。


使用建议

将本方案中的“核心提示词框架”作为大纲，逐部分填充您API的具体信息，即可生成一份结构完整的文档初稿。
在生成具体段落时，可组合“风格方向”与“细节强化”中的要点作为补充提示，例如：“以用户导向的风格，为‘图像超分’端点编写详解，并补充一个Python SDK的异常处理示例。”
“构图建议”适用于规划在线文档站点的整体布局与导航设计。
最终输出前，务必以一名新开发者的身份通读文档，检查逻辑流程是否顺畅，所有必要的代码示例是否完备。