高阶版后端接口PRD需求文档提示词
本提示词方案专为技术文档撰写者与产品经理设计,旨在生成一份结构严谨、细节完备的高阶后端接口PRD文档。
后端接口
PRD
需求文档
提示词内容
可直接复制使用
角色定义与任务定位 请以「资深后端架构师兼技术产品经理」的身份进行创作。你的核心目标是:为开发团队生成一份逻辑严密、边界清晰、可直接指导设计与开发的高质量后端接口需求文档(PRD)。这份文档需超越基础功能描述,深入涵盖技术约束、非功能性需求及协作规范。 适用场景 复杂业务系统或微服务架构下的新接口定义。 现有接口的重大重构或版本升级需求说明。 需要明确技术细节、性能指标和安全规范的正式开发任务。 跨团队协作中,作为唯一可信源的技术需求基准文档。 核心提示词 可直接复制并填充具体信息使用的提示词结构: 生成一份关于「[具体业务模块/功能点,如:用户积分消费]」的后端接口PRD。 文档必须包含以下章节:1. 变更记录与评审状态;2. 接口概述与业务价值;3. 调用关系图与数据流;4. 详细的请求/响应参数表(字段名、类型、必填、示例、约束说明);5. 完整的业务规则与异常状态码定义;6. 非功能性需求(性能、安全性、幂等性、限流策略);7. 数据一致性方案与潜在风险点;8. 联调测试要点与验收标准。 遵循RESTful设计规范,使用JSON格式,并明确API版本号。 风格方向 文体风格:采用技术公文风格,表述精确、客观、无歧义。避免口语化和营销性词汇。 视觉结构:层级分明,善用编号列表、表格和流程图标记(如Mermaid语法描述)。关键信息高亮或加粗。 术语标准:统一使用技术团队约定的术语体系,对首次出现的缩写进行全称注解。 构图建议(文档结构框架) 顶层框架:采用“总-分-详”结构。开篇定调(目标、范围、背景),中部展开核心接口设计,末尾收束于测试与运维考量。 核心展开区:以“接口详情”章节为重心,采用“表格+说明文字”的复合布局。每个接口独立成节,参数表与业务逻辑说明紧密相邻。 辅助视图:在概述部分嵌入系统上下文图或时序图,直观展示接口在整体架构中的位置与协作关系。 细节强化 参数细节:不仅定义类型,还需说明枚举值含义、取值范围、加密要求、默认值及触发条件。 异常处理:定义全局及接口特有的错误码,并附上客户端处理建议(如:重试策略、用户提示文案)。 性能指标:量化要求,如:P99响应时间 < 200ms,单机QPS > 1000,支持每秒XX笔事务处理。 安全与合规:明确身份认证方式(如OAuth 2.0)、权限校验点、敏感数据脱敏规则、日志审计要求。 兼容性与演进:说明前后版本兼容性策略、字段废弃计划、灰度发布方案。 使用建议 在使用核心提示词时,请将方括号「[]」内的占位符替换为您的具体业务信息,这是生成有效文档的关键第一步。 可要求AI先生成文档大纲,经确认后再逐章节深化内容,以更好地控制文档质量与方向。 生成的文档初稿,务必由技术负责人结合具体技术栈(如数据库类型、中间件)进行可行性评审与细节补充。 将“非功能性需求”和“验收标准”作为与开发、测试团队对齐的强制条款,可有效减少后续沟通成本。