高质量后端接口PRD需求文档提示词

角色定义与任务定位
请以资深后端产品经理或技术文档架构师的身份，运用本方案。你的核心目标是：系统性地构思并撰写一份逻辑严密、技术描述准确、对开发团队极具指导价值的后端接口产品需求文档（PRD）。本方案旨在为你提供结构化的内容框架与灵感提示，而非泛泛而谈的写作原则。

适用场景

为全新业务模块设计API接口规范。
对现有接口进行重大迭代升级，需要重新定义需求。
向开发、测试团队交付清晰、无歧义的技术实现依据。


核心提示词
以下提示词组合可直接或稍作修改后，用于引导文档生成工具或作为你撰写时的核心提纲：

撰写一份关于【用户积分兑换】模块的后端接口PRD。文档需包含：接口概述、调用方、请求与响应参数详表（字段名、类型、是否必填、示例值、备注）、业务规则（如积分扣减与商品库存的原子性操作）、状态码定义、错误码枚举、幂等性设计、限流策略及数据安全考量。
为【文件分片上传与合并】接口编写需求文档。重点描述：分片大小计算逻辑、MD5校验机制、服务端临时存储与最终合并的流程、并发上传处理、失败分片的重传策略，并提供完整的接口时序图。
起草【多条件复合查询】列表页接口的PRD。明确：可查询字段及其匹配方式（精确、模糊、范围）、排序规则、分页方案（基于游标或页码）、响应数据结构的扁平化与嵌套选择、以及查询性能优化建议（如数据库索引提示）。


风格方向

结构严谨：采用标准的“背景-范围-详细规格”层次，使用编号和标题保持清晰层级。
表述精确：使用“必须”、“应当”、“禁止”等确定性词汇，避免“可能”、“大概”等模糊表述。
技术导向：聚焦于数据流、状态变迁、边界条件和异常处理，而非前端交互细节。
用例驱动：关键业务逻辑需辅以正例、反例或异常用例说明，确保无二义性。


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

1. 文档头：版本历史、修订人、评审状态。
2. 概述：业务背景、接口核心价值、涉及的系统范围。
3. 全局约定：通用请求/响应头、认证授权方案、数据格式（JSON/Protobuf）、时间戳格式、枚举值全局定义。
4. 接口详述（每个接口）：接口名称、路径、方法；功能描述；请求参数表；响应参数表；业务逻辑流程图或状态机；错误码列表。
5. 非功能性需求：性能指标（QPS，P95/P99延迟）、可用性SLA、数据一致性要求、监控与告警关键点。
6. 附录：关键算法伪代码、数据库表结构变更、兼容性说明。


细节强化

参数描述：不仅说明类型，更要说明“为什么”。例如：“`user_level` (整数，必填)，用于区分不同等级用户的兑换费率，来源于用户服务的最新快照”。
边界与异常：明确描述参数为空、越界、重复提交、依赖服务超时等场景下的系统行为与返回信息。
安全与合规：指出敏感数据（如手机号）的脱敏展示规则、数据权限校验点、防刷量机制的设计位置。
扩展性提示：在关键字段备注“预留，供未来扩展使用”，为后续迭代留出设计空间。


使用建议

将【核心提示词】中的【】替换为你的具体业务对象，即可作为初稿生成指令。
在撰写“接口详述”时，可结合风格方向与细节强化要点，逐项检查内容的准确性与完整性。
最终文档应能通过此测试：一位陌生的中级后端工程师仅阅读此PRD，即可在不二次询问的情况下，完成接口的准确开发。