后端接口技术方案写作高阶版提示词
本提示词方案专为技术文档撰写者与架构师设计,旨在提供一套结构化、可操作的高阶指导,用于生成...
提示词内容
复制角色定义与任务定位
请以“资深后端架构师”或“技术方案主笔人”的身份,运用本提示词方案。你的核心目标是:系统性地构思并撰写一份专业、严谨、可落地的后端接口技术方案文档,确保方案在技术可行性、架构清晰度、团队协作效率及未来可维护性上达到高标准。
适用场景
- 面向产品、前端、测试等多团队进行技术方案评审与同步。
- 为新功能迭代或系统重构定义清晰的接口契约与实现路径。
- 将模糊的业务需求转化为具体、可开发的技术规格说明书。
- 建立团队内部接口设计与文档编写的标准化参考。
核心提示词
可直接用于引导文档生成的核心提示结构:
- 撰写一份关于【具体业务模块,如:用户积分体系】的后端接口技术方案。
- 方案需包含:业务背景与目标、系统边界分析、接口详细设计(URI、方法、请求/响应体结构、状态码)、数据模型设计、核心业务流程时序图、异常处理与降级策略、性能与安全考量、部署与监控建议、后续迭代规划。
- 采用严谨的技术文档风格,语言精确,结构层次分明,关键部分使用加粗或列表突出。
风格方向
- 文体风格:专业、客观、精确的工程技术文档风格。避免口语化与模糊表述。
- 视觉基调:逻辑清晰、信息密度高、重点突出。想象一份优秀的架构图:模块分明,连线精准,注释到位。
- 色彩隐喻:以“深蓝”代表稳定与可靠(核心架构),“灰色”代表中立与清晰(基础描述),“橙色”或“红色”代表需要特别注意的警示、关键约束或核心流程。
构图建议
- 文档结构骨架:采用“总-分-总”的宏观构图。先定义范围与目标(总览),再分层展开细节(分述),最后总结风险与规划(收尾)。
- 信息分层布局:使用多级标题构建清晰的文档层次。将文字描述、表格(参数表)、图表(时序图、ER图)有机结合,避免大段纯文本堆砌。
- 焦点引导:将“接口契约”与“核心流程”作为文档的视觉与逻辑焦点,用更详细的篇幅和更直观的图表进行呈现。
细节强化
- 接口设计:明确每个接口的幂等性、安全性、请求频率限制。响应体结构需包含清晰的code、message、data分层。
- 数据模型:不仅列出字段,还需说明类型、约束、索引设计及与其他实体的关联关系。
- 异常流:详细定义各类业务异常、系统异常的触发条件、错误码与客户端处理建议。
- 非功能性需求:具体化性能指标(如QPS、RT要求)、数据一致性级别(强一致/最终一致)、缓存策略与容量评估。
- 术语与一致性:全文统一关键术语的英文缩写与中文译名,保持命名规范一致。
使用建议
- 在使用AI辅助生成初稿时,将“核心提示词”部分的具体内容替换为你的实际项目信息,可得到更精准的草稿。
- 生成的方案文档需经过人工复核,重点检查技术逻辑的闭环性、与现有系统的兼容性以及所有假设条件是否明确。
- 可将此提示词方案作为团队内部的“写作清单”,确保每位成员撰写的技术方案都覆盖关键模块,风格统一。
- 方案评审时,可依据本提示词中的“细节强化”要点逐项审视,提升评审深度与效率。