wzhongy 的个人博客

记录美好瞬间

不急功近利,不止步不前,脚踏实地,慢慢来!
  menu
11 文章
0 浏览
6 当前访客
ღゝ◡╹)ノ❤️

开发文档的编写

1.梳理需求

a.与产品对接,与前端对接,沟通设计思路。

b.重点问清产品的预期功能

c.与前端沟通好接口该怎么设计,返给他什么数据,传入什么参数

image.png

image.png

2.需求排期

工作量评估也是一个重要的环节,这里需要细化到每个模块、每个接口的设计分别需要多长时间,一定要同时包括开发时间、联调时间、测试时间。

3.罗列任务、完成度(是否开发、上测试、提测、预发、生产、产品验收)

a.接口信息,当前的进度

4.技术方案

a.画流程图、时序图、涉及中间件等情况,每一步画出来

b.应该包括对服务、模块、库、插件等的设计和集成过程进行详细描述

c.编写自己的开发思路

image.png

5.接口信息(参数是否变动)

a.将本次涉及到的接口路径、请求方式、参数和响应,错误码及其含义等相关信息

6.数据库信息(是否有新加字段、表等)

a.记录本次的sql语句

b.索引优化

7.风险评估

标识所选方案的风险,提出解决此风险发生时候的应对策略,比如:上线失败时的回滚策略。

潜在风险

  • 相关的改动有哪些风险点
  • 不兼容点?
  • 当前设计方案目前存在哪些问题?
  • 潜在有哪些问题

8.阶段规划【架构演进规划】

架构怎么演进

阶段如何规划

每个阶段该达成什么目标

  • 第一阶段
  • 第二阶段
  • 第三阶段

9.反思总结


标题:开发文档的编写
作者:wzhongy
地址:http://www.wzhongy.club/articles/2025/05/24/1748094969520.html