BI报表API文档生成专业版提示词

角色定义与任务定位

请以“技术文档工程师兼数据可视化设计师”的身份，运用本提示词方案。你的核心目标是：生成一份将BI报表（商业智能报表）的数据洞察与API（应用程序编程接口）的技术规范深度融合的专业文档。这份文档需同时服务于开发者的集成调用需求与业务决策者的数据理解需求，确保技术准确性与信息可读性并重。

适用场景

• 为具备数据查询或导出功能的BI工具编写配套API接口说明。
• 创建整合了关键业务指标（KPI）图表与对应API调用的开发手册。
• 生成用于内部数据平台或数据产品上线的综合性技术文档。
• 制作面向客户的数据服务API文档，并附带报表效果预览。

核心提示词

可直接用于生成或引导内容创作的核心指令组合：

• 生成一份BI报表数据API的RESTful接口文档，需包含[认证方式]、[端点URL]、[请求/响应示例]及[报表参数映射说明]。
• 请用序列图（Sequence Diagram）描述从“前端请求”到“BI引擎处理”再到“API返回JSON数据”的完整调用流程。
• 将以下关键指标：[销售额、用户增长率、地区分布] 的报表可视化图表（如折线图、柱状图），与获取该数据的API查询参数进行并列对照说明。
• 撰写“错误代码（Error Code）”章节，明确列出如“无效的日期范围参数”、“超出数据权限”等常见错误及其对应的解决方案。
• 提供一段Python/Java代码片段，演示如何调用API获取数据，并使用Matplotlib/Chart.js库生成简易的BI趋势图。

风格方向

• 专业技术风格：采用清晰、客观、严谨的技术文档语言，避免营销化表达。
• 结构化排版：强调模块化布局，使用明确的层级标题（如1.概述、2.接口详情、3.报表字段说明、4.示例）。
• 视觉融合：在文档中自然嵌入报表图表的缩略图或示意图，并与API参数说明相邻放置，形成图文对照。
• 色彩与标识：对代码块、警告提示、重要参数使用统一的色块或图标进行标识，提升可读性。

构图建议（文档布局与视觉组织）

• 采用“左文右图”或“上图下文”的布局，将API请求示例与对应的报表输出效果图紧密关联展示。
• 为每个主要API模块设计一个“信息卡片”，卡片内部分区展示：接口功能简述、HTTP方法、URL、以及一个微型报表预览区。
• 在文档顶部设计一个“快速导航”区域，通过锚点链接并列跳转到“核心报表介绍”和“API总览”两部分。
• 使用流程图或架构图来展示数据从源数据库经BI处理，再通过API服务输出的整体链路。

细节强化

• 参数细节：对每个API参数，不仅说明数据类型，还需说明其在BI报表中对应的筛选器、维度或度量角色。
• 示例强化：提供“成功响应”和“错误响应”的完整JSON体，并在其中用注释标明关键业务数据字段。
• 版本控制：明确标注API版本号及对应的BI报表版本，管理变更历史。
• 交互提示：在可交互的文档中，考虑加入“一键复制代码”按钮或“在API测试工具中打开”的链接。
• 术语表：在文档末尾附上BI领域与API领域的关键术语对照解释。

使用建议

• 在使用AI生成或辅助撰写时，请将“核心提示词”中的具体指令作为主要输入，并明确指定输出格式（如Markdown）。
• 首先生成文档主干框架和示例，再根据实际API接口的详细规范填充和修正具体参数与描述。
• 生成的报表示意图或架构图，应确保其风格与文档整体的专业感、简洁感保持一致。
• 最终文档完成后，建议邀请开发人员（验证API部分）和业务分析师（验证报表数据对应关系）进行双重审阅。