后端接口产品说明文档清晰框架提示词

角色定义与任务定位

请以“技术文档架构师”或“资深后端产品设计师”的身份，运用本提示词方案。你的核心目标是：系统化地构建一份逻辑严谨、描述准确、便于开发与测试团队直接使用的后端接口产品说明文档，确保技术实现的透明性与协作效率。

适用场景

• 为新产品或新功能模块设计初始接口文档框架。
• 对现有零散或模糊的接口描述进行标准化重构与优化。
• 在敏捷开发流程中，快速生成可供评审和开发的迭代文档。
• 构建团队内部统一、可复用的接口文档内容模板。

核心提示词

以下提示词组合可直接用于内容生成，请根据实际情况填充【】内的具体信息：

• 撰写【用户登录】接口的产品说明文档，需包含接口概述、请求URL、请求方法、请求参数表（含参数名、类型、是否必填、示例值、说明）、请求体示例、响应体示例（成功与失败）、状态码说明、错误码枚举。
• 以清晰的分层结构，说明【订单创建】接口的业务逻辑流程、数据校验规则、幂等性处理方案以及与其他微服务的依赖关系。
• 生成一份符合RESTful设计规范的API文档，重点描述资源路径规划、HTTP方法应用场景、查询过滤与分页参数的设计。
• 补充接口的非功能性要求，包括但不限于性能指标（QPS、响应时间）、安全要求（鉴权方式、数据加密）、限流策略与降级方案。

风格方向

• 专业严谨：使用准确的技术术语，避免口语化和歧义表述，保持客观中立的叙述语气。
• 结构清晰：采用分级标题（如1. 概述， 2. 接口详情， 2.1 请求说明…）、列表和表格来组织复杂信息，提升可读性。
• 用户导向：文档内容需考虑读者（开发者、测试员）的认知路径，从概述到细节，从正常流程到异常处理。

构图建议（信息架构）

• 顶层框架：采用“文档头（版本、修订历史）- 正文 - 附录”的经典结构。
• 正文核心层：按“模块/业务域”划分章节，每个接口独立成节。节内按“概述 -> 接口定义 -> 请求/响应详解 -> 业务规则 -> 示例 -> 注意事项”的逻辑流展开。
• 细节层：使用表格呈现参数与枚举值，使用代码块展示JSON示例，使用流程图或序列图说明关键交互逻辑（可在提示词中描述图的内容）。

细节强化

• 参数描述：不仅说明“是什么”，更需解释“为什么”和“如何用”，特别是边界值、枚举含义和业务约束。
• 示例的完整性：提供典型场景、边缘场景及错误场景的完整请求/响应示例，包括HTTP头部信息。
• 版本与变更：明确文档版本号，并以表格形式记录每次修订的日期、版本、修改内容、修改人，便于追溯。
• 术语一致：全文保持核心概念、字段命名、错误码前缀的统一，建立文档内部的术语表。

使用建议

• 在使用核心提示词时，将【】替换为具体的业务对象（如“支付回调”、“商品查询”），可快速启动文档撰写。
• 可结合“风格方向”与“细节强化”中的要点，作为补充指令，要求生成内容具备特定细节或符合特定格式。
• 本方案产出的是内容框架与文本，流程图、时序图等可视化部分需在提示词中明确描述，或使用专业绘图工具另行生成。
• 建议将生成的文档作为初稿，结合实际的系统设计和团队规范进行复核与微调，以确保百分百的准确性。