高质量BI报表API集成说明提示词

角色定义与任务定位
请以“技术文档工程师”或“API产品经理”的身份，以“创建一份清晰、完整、可高效指导开发者完成BI报表数据接入的集成说明文档”为核心目标来运用本提示词。你的产出不是简单的功能列表，而是一份能够降低集成门槛、提升开发效率的标准化技术指南。

适用场景

为商业智能（BI）平台（如Tableau, Power BI, FineReport等）编写官方API集成文档。
为内部数据中台或数据分析团队制作统一的数据服务接入规范。
为第三方合作伙伴或客户提供标准的报表数据集成方案。
在开发者门户或帮助中心构建结构化的API使用指南。


核心提示词
以下提示词组合可直接或稍作调整后用于文档生成或大纲构建：

“编写一份详尽的BI报表API集成指南，涵盖从认证授权、数据查询到错误处理的完整流程。”
“以步骤化形式说明如何通过RESTful API将业务系统数据实时同步至BI报表模板。”
“创建包含快速入门、核心接口详解（如：/api/v1/dataset, /api/v1/report）、参数说明与代码示例（Python/Java）的集成文档。”
“撰写聚焦于数据安全与性能优化的API集成最佳实践说明，包括令牌刷新机制与分页查询建议。”


风格方向

专业严谨：使用准确的技术术语，保持客观中立的表述，避免模糊或营销化语言。
用户导向：以开发者视角组织内容，采用“任务驱动”的叙述逻辑，明确每一步的目标和产出。
结构化清晰：文档应具备清晰的层级（概述→前置准备→接口详解→示例→排错），便于快速导航和查阅。
简洁直接：句子简短有力，重点突出，关键信息（如URL、参数、错误码）使用等宽字体或高亮予以区分。


构图建议（文档结构框架）

顶层概述：开篇明义，说明此API的用途、核心价值与适用场景。
前置准备区：集中列出获取API密钥、配置白名单、安装必要SDK等初始步骤。
核心流程轴：按“认证→构建请求→解析响应→处理异常”的时间线展开，可配以顺序图或流程图。
接口详情矩阵：以表格形式清晰展示每个接口的Method、Endpoint、请求/响应参数及示例。
代码示例块：提供主流语言的完整、可运行的代码片段，并附有关键行注释。
附录与问答区：收纳常见错误码表、速率限制、数据格式对照表及高频问题解答。


细节强化

关键参数：对敏感参数（如api_key）、复杂参数（如查询过滤条件JSON结构）进行单独详解和示例。
状态与错误：明确列出所有可能的HTTP状态码和业务错误码，并提供具体的原因和解决步骤。
版本管理：明确标注API版本号，并对不同版本的差异进行说明，给出兼容性建议。
安全强调：在显著位置强调传输加密（HTTPS）、密钥保管、权限最小化等安全要求。
性能提示：指出影响性能的关键点，如推荐使用增量同步接口、合理设置查询时间范围等。


使用建议

在撰写前，亲自走通一遍集成流程，记录所有卡点和注意事项。
使用“核心提示词”作为不同章节的写作起点或内容提示，填充具体细节。
遵循“风格方向”，确保全文语调一致，避免部分章节过于技术晦涩而另一部分又过于随意。
利用“构图建议”搭建文档骨架，再通过“细节强化”部分填充血肉，使文档既全面又深入。
最终文档应支持开发者“复制-粘贴-微调”即可完成基础集成，并能在遇到问题时快速定位到解决方案。