后端接口PRD需求文档高阶版提示词

角色定义与任务定位

请以「资深技术产品经理」或「后端系统架构师」的身份，运用本提示词方案。您的核心目标是：为开发团队生成一份逻辑严密、边界清晰、可直接指导开发与测试的「后端接口需求规格说明书」，确保需求传递零歧义，提升研发协作效率。

适用场景

• 新产品功能模块的后端接口定义与评审。
• 现有系统接口迭代升级的需求澄清与文档化。
• 跨团队或对外开放API的标准化契约制定。
• 作为自动化测试用例生成与接口Mock的数据基础。

核心提示词

可直接复制使用的提示词组合示例：

• 为「[具体业务模块，如：用户积分兑换]」模块编写一份高阶PRD，需详细定义RESTful接口，包含：接口名称、版本、请求方法、URL、请求头、鉴权方式、请求参数（必填/选填、类型、示例、约束）、响应结构（成功/失败状态码、数据字段说明、示例）、业务规则、错误码枚举、性能要求（QPS、响应时间）及兼容性说明。
• 作为系统架构师，请输出「[接口名称，如：提交订单]」接口的详细需求。重点描述：幂等性设计、并发控制方案、数据一致性保障、依赖的外部服务与降级策略、关键业务状态流转图、以及敏感数据（如金额、ID）的加密与验证逻辑。
• 生成一份面向开发者的「[微服务名称，如：PaymentService]」核心接口文档。要求采用表格形式清晰呈现每个字段，并附带完整的请求/响应JSON示例、异常场景枚举（如网络超时、库存不足、支付渠道失败）及对应的重试或补偿机制建议。

风格方向

• 文体风格：采用技术文档的客观、精准、无歧义书面语。避免口语化和模糊词汇（如“大概”、“可能”）。
• 结构风格：遵循“总-分”结构，先概述接口目的与业务场景，再逐项分解技术细节。强调模块化与层次感。
• 视觉风格：在文档排版上，善用标题分级、列表、表格、加粗关键词、代码块（用于JSON示例）等元素，营造专业、清晰的阅读体验。

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

• 顶层框架：文档标识（标题、版本、作者） -> 修订历史 -> 1. 概述（目标、范围、名词解释） -> 2. 全局约定（鉴权、编码、时区、公共参数） -> 3. 接口详细设计（按模块分节）。
• 接口单元结构：每个接口建议按“接口描述 -> 基本信息（方法、URL） -> 请求参数表 -> 响应参数表 -> 业务逻辑流程图/状态图 -> 错误码表 -> 示例”的顺序展开。
• 焦点引导：将“非功能性需求”（如性能、安全、监控）独立成章，置于接口详述之后，确保其不被细节淹没。

细节强化

• 边界与异常：明确每个参数的取值范围、格式正则、为空策略。详细定义所有可能的错误场景（业务异常、系统异常）及客户端处理建议。
• 数据与枚举：所有状态码、类型枚举值必须明确定义其含义和触发条件，避免出现“0代表成功，1代表失败”这种未定义完全的描述。
• 时序与依赖：对于涉及多步骤或依赖外部调用的接口，使用序列图或文字清晰说明调用时序、超时设置和失败回滚机制。
• 安全与合规：明确指出接口涉及的数据敏感等级（PII、PCI）、必要的加密字段（如密码、手机号）、防刷策略（频次限制）和权限校验点。

使用建议

• 在使用AI生成初稿后，务必结合具体业务逻辑进行人工复核与补充，特别是复杂的业务规则和状态机。
• 将“核心提示词”中的占位符（如[ ]）替换为您的具体业务对象，能获得更精准的产出。
• 本方案生成的文档，建议与UML图（时序图、状态图）、API Mock工具（如Swagger、Postman）结合使用，形成“可读文档 + 可运行定义”的交付组合。
• 在团队内推行本提示词定义的文档结构作为标准模板，可极大统一认知，减少沟通成本。