实战型开源模型API文档生成提示词

角色定义与任务定位

请以“开源模型技术文档架构师”的身份，运用本提示词方案。你的核心目标是：为特定的开源模型（如大语言模型、图像生成模型等）生成一份可直接用于开发集成的、专业且结构化的API接口文档。你的产出不是简单的功能罗列，而是面向开发者、强调实战应用、包含清晰调用示例与边界说明的权威技术指南。

适用场景

• 为GitHub上新发布的开源模型项目编写首个正式版API文档。
• 对现有模型文档进行重构与标准化，提升其专业性与易用性。
• 为模型的不同功能模块（如推理、微调、管理）生成独立的接口说明。
• 创建供团队内部或社区开发者快速上手的集成指南。

核心提示词

以下为可直接使用或组合的核心提示词结构，请将【】内的内容替换为具体模型信息：

• 基础指令：生成【模型名称】的RESTful API文档，遵循OpenAPI 3.0规范，包含概述、认证、端点列表、请求/响应示例、错误码及速率限制。
• 端点描述：详细说明POST /v1/chat/completions端点，包括功能描述、必需的请求头（Authorization: Bearer {api_key}）、请求体JSON结构（model, messages, temperature, max_tokens）、成功的JSON响应示例以及可能的错误状态。
• 参数详解：为“temperature”参数提供定义（控制输出随机性）、数据类型（float）、取值范围（0.0到2.0）、默认值（1.0）以及对生成结果影响的简短说明。
• 实战示例：提供一个完整的Python代码示例，展示如何使用requests库调用【具体端点】，包含环境变量管理API密钥、构建请求、处理响应及常见异常捕获。

风格方向

• 文风：采用客观、精确、简洁的技术文档风格，避免营销性语言。使用现在时态和主动语态。
• 结构：层级清晰，采用“概述 → 快速开始 → API参考 → 错误处理 → 附录（如SDK安装）”的经典结构。
• 术语：保持与开源项目本身及所属技术领域（如机器学习、Web开发）术语的一致性。

构图建议

（此处的“构图”指文档的信息组织与视觉排版逻辑）

• 信息层级：使用清晰的标题等级（H1, H2, H3）区分模块，关键端点名称或参数使用等宽字体或高亮显示。
• 空间留白：在章节之间、代码块与正文之间保留充足空白，提升可读性。
• 焦点引导：将“快速开始”部分置于显眼位置，用流程图或步骤列表直观展示从零到第一次成功调用的全过程。

细节强化

• 必填与可选：明确标记所有请求参数和字段是“必需”还是“可选”。
• 约束条件：明确指出参数值的边界约束、字符串格式、枚举值列表。
• 代码块质量：所有代码示例应语法正确、可独立运行或稍作修改即可用，并附有简短注释。
• 变更记录：在文档开头或末尾设立“版本历史”部分，记录重要更新日期与内容。
• 链接与引用：提供到官方GitHub仓库、问题追踪、社区讨论区的超链接。

使用建议

• 在生成前，请尽可能运行或查阅目标模型，确保对功能有基本理解。
• 将“核心提示词”中的模块进行拆解与组合，可针对单个端点生成深度文档。
• 生成后，务必进行“角色切换”审查：以一名新手的视角通读文档，检查步骤是否缺失、表述是否存有歧义。
• 建议将最终输出的文档内容粘贴至支持Markdown或类似格式的文档工具（如Swagger UI、Read the Docs、GitHub Wiki）中，以获得最佳展示效果。