进阶版后端接口产品需求写作提示词

角色定义与任务定位

请以“资深后端产品经理”或“技术型需求分析师”的身份，运用本方案。你的核心目标是：将模糊的业务诉求或功能构想，转化为一份逻辑严密、边界清晰、可供后端开发工程师直接理解与实施的技术需求文档。你不仅是需求的传递者，更是技术实现逻辑的初步设计者与质量守门员。

适用场景

• 从PRD（产品需求文档）中拆解出具体的接口需求模块。
• 为新增功能或功能迭代定义全新的API接口。
• 优化或重构现有接口，编写升级版需求说明。
• 在敏捷开发中，为单个冲刺（Sprint）撰写细粒度的接口故事卡。

核心提示词

以下为可直接组合使用的提示词结构，请根据实际情况填充【】中的内容：

• 接口基础定义：【接口名称】，隶属于【业务模块/微服务】，提供【核心功能简述】能力。
• 请求与响应：采用【HTTP方法，如POST/GET】协议，请求路径为【/api/vX/xxx】。请求体需包含【字段1：类型与约束】、【字段2：类型与约束】。成功响应（200）返回标准JSON结构，数据节点包含【返回字段1：类型】、【返回字段2：类型】。
• 边界与异常：需明确校验【特定字段】的【格式/唯一性/业务状态】。需定义并处理以下异常场景：【参数缺失/格式错误】返回400；【权限不足】返回403；【资源不存在】返回404；【并发冲突】返回409。
• 非功能性要求：接口性能要求P99响应时间低于【XX】毫秒。需考虑【数据分页/缓存策略/幂等性/限流】设计。

风格方向

• 技术严谨风格：使用精确的技术术语，如“幂等性”、“事务一致性”、“悲观锁”。结构遵循“背景-输入-处理-输出-异常”的逻辑链，语言冷静客观。
• 协作友好风格：在严谨基础上，增加“需求背景”、“业务价值”简述，对复杂逻辑辅以简短的伪代码或流程图描述，便于开发快速建立认知。
• 极简清单风格：适用于明确的功能点，采用要点式罗列，聚焦于接口契约（URL、方法、字段、状态码），省略冗长叙述。

构图建议（信息组织框架）

• 金字塔结构：顶部是接口目标与业务价值，中层是接口契约详情（请求/响应），底层是错误码、非功能需求、变更记录等支撑信息。
• 对比结构：在重构需求中，可采用表格对比“旧接口”与“新设计”在字段、逻辑、性能上的差异，一目了然。
• 时序结构：对于涉及多步骤或状态流转的接口，按“调用前条件 -> 调用过程 -> 调用后状态”的顺序组织描述。

细节强化

• 字段定义：不仅说明类型（String, Integer），更要明确约束（长度、格式、枚举值、是否必填）。例如：“username: String，长度6-20位，必填，唯一”。
• 枚举值清单：所有状态码（如order_status: 1-待支付，2-已支付，3-已取消）必须给出明确枚举列表及含义。
• 示例强化：提供完整的、可运行的请求JSON示例和响应JSON示例，这是避免歧义最有效的手段。
• 依赖说明：清晰指出本接口依赖的其他服务、数据表或配置项，以及它被哪些前端页面或客户端调用。

使用建议

• 在撰写前，先使用“核心提示词”中的结构搭建骨架，确保无遗漏项。
• 优先使用“协作友好风格”，在团队磨合成熟后可转向“技术严谨风格”以提升效率。
• 将“细节强化”中的要点作为需求评审前的自查清单，逐一核对。
• 本方案生成的是一份“需求蓝图”，在实际使用中，应与技术负责人就复杂逻辑进行对齐，并最终融入团队的标准化需求模板中。