进阶版数据分析API文档生成提示词

角色定义与任务定位

请以一名资深技术文档工程师兼数据分析产品专家的身份，运用本提示词方案。你的核心目标是：为复杂的数据分析API生成一份逻辑严谨、示例丰富、便于开发者快速集成与调用的高质量技术文档，确保文档兼具技术准确性与用户友好性。

适用场景

• 为内部数据分析平台或对外数据服务产品编写RESTful或GraphQL API文档。
• 将数据分析模型（如预测、聚类、报表生成）的能力封装为API后的说明文档撰写。
• 为数据可视化、商业智能（BI）工具的后端数据接口提供使用指南。
• 在敏捷开发中，快速生成与迭代API文档，保持与代码同步。

核心提示词

（以下为可直接组合使用的提示词模块，请根据具体API功能选取并组合）

• 基础框架：生成一份关于[具体API名称，如：用户行为分析查询API]的完整文档，包含概述、认证、端点、请求/响应参数、状态码、示例及错误处理。
• 功能描述：详细说明该API用于[具体数据分析任务，如：执行多维时间序列聚合计算]的核心功能，强调其数据处理能力和输出价值。
• 参数详解：清晰定义请求参数，特别是数据分析相关参数，如：`metrics`（指标）、`dimensions`（维度）、`start_date`（时间范围）、`filter_conditions`（过滤条件）、`aggregation_method`（聚合方法）。
• 响应示例：提供包含典型数据分析结果的JSON响应示例，展示如`data_points`、`summary_statistics`（均值、总数）、`trend`（趋势）等结构化数据字段。
• 行业应用提示：在示例中融入[电商、金融、社交]等具体行业的数据模型与业务指标，增强文档的场景贴合度。

风格方向

• 专业严谨：采用技术文档的标准语调和格式，术语准确，逻辑层层递进。
• 用户导向：语言在保持专业的同时力求清晰，避免不必要的晦涩，始终从开发者调用角度进行描述。
• 结构化视觉：在提示词中引导生成具有清晰层级（如章节标题、代码块、参数表格）的文档结构，即使纯文本也具备“视觉”上的可读性。
• 实用主义：重点突出“如何用”，而非“是什么”，每个部分都指向具体的操作或理解。

构图建议（文档结构布局）

• 顶部导航：文档标题、版本号、快速跳转锚点。
• 主体流线：按照“快速开始 → 核心概念 → 详细端点说明 → 示例代码 → 错误参考”的顺序组织内容，形成从入门到精通的自然流线。
• 代码与文本区隔：明确区分描述性文字和可执行的代码片段（如cURL、Python、JavaScript请求示例）。
• 参数表格化：将请求/响应参数以“名称、类型、必填、描述、示例”的表格形式呈现，信息密度高且一目了然。

细节强化

• 数据安全与限制：明确说明数据权限、速率限制、单次请求数据量上限、数据延迟等关键约束条件。
• 典型业务场景示例：提供从“业务问题”到“API调用”再到“结果解读”的端到端小案例，例如：“如何获取上周每日GMV趋势”。
• 错误码情景化：为每个常见错误码（如`400 Invalid Filter`）提供可能的原因和调试建议，而不仅仅是代码定义。
• 版本变更提示：如果涉及，明确指出当前版本与旧版本的差异，帮助用户平滑升级。
• 扩展链接：提示关联其他相关API文档或数据分析模型的白皮书，形成知识网络。

使用建议

• 在使用本提示词生成初稿后，务必代入开发者视角进行审阅，检查逻辑跳转是否顺畅，示例是否可运行。
• 将“核心提示词”中的括号占位符（如[具体API名称]）替换为您的实际项目信息，是获得有效内容的关键第一步。
• 可先使用“基础框架”+“功能描述”生成主干，再逐步嵌入“参数详解”和“响应示例”来丰满内容。
• “风格方向”和“构图建议”用于在生成过程中或生成后，调整和优化文档的整体质感与可读性。
• 将生成的文档与Swagger/OpenAPI等规范工具结合，可进一步自动化流程。