实战分享:开发设计文档模版及编写要点

news/2024/12/27 3:51:00/

总框架

一、需求类开发设计文档模版

1、PRD链接

PRD文档链接

2、后端设计

1)流程图/代码逻辑描述

描述代码逻辑,要求清晰准确,尽量用图表描述

超过3人天工作量的需求必须有流程图

2)库表设计

涉及数据库的改动,包括但不限于DML、DDL、ER图等

3)配置设计

涉及配置的改动,如果分布式配置、MQ主题配置、数据字典配置等

4)接口设计

涉及接口的改动,一般用接口卡描述

接口地址

/xxx/xxx/xxx/xxx

说明
请求方式POST
请求参数说明


字段说明类型是否必填备注

lineDetailIds

发车单id集合List<Long>
lockFlag锁定状态int锁定传1,解锁传0



请求实例

{"lineDetailIds":[1],"lockFlag":0}


响应参数说明


字段说明类型备注
code响应码String0-成功,1-失败
msg消息String
Success成功
errMsg错误消息
String

timestamp时间戳String
data
数据
Object
提示信息



响应实例

{
    "code": "0",
    "msg": "Success",
    "errMsg": "",
    "timestamp": "",
    "data": null
}


3、前端设计

1)页面设计

涉及页面UI的改动

2)前端交互逻辑设计

涉及页面交互逻辑的改动

4、测试建议

1)测试建议

给出代码的影响范围及测试建议

2)是否影响性能

分析是否影响性能,如何影响,是否需要压测

5、工作量评估

1)前后端工时评估(分析、设计、编码、测试等工作量总和,单位小时)

开发设计:编码:自测的比例建议是5:2:3
应该在设计上多花时间,避免返工

角色

需求评审/缺陷分析(小时)

开发设计(小时)

编码(小时)

自测与bug修复(小时)

总工时(小时)

后端




前端




2)前后端联调时间

给出前后端联调时间(如不需要联调可不写)

3)转测时间

给出转测时间,需注明日期和上午/下午

二、缺陷类开发设计文档

1、影响场景

描述缺陷产生的场景,以及缺陷的影响范围

2、原因分析

分析缺陷产生的原因,最好有截图举证

3、解决方案

描述解决方案,采取什么措施解决这个缺陷
涉及到数据库结构变化或者接口调整,需要重点澄清

4、测试建议

与需求类一样,这里不再赘述

5、工作量评估

与需求类一样,这里不再赘述

三、技改类开发设计文档

1、重构目标

明确需要重构的代码模块或功能;补充前端使用场景

2、重构版本

锚定重构的分支及版本

3、后端设计

1)现有流程图/代码逻辑描述

描述现有代码逻辑,要求清晰准确,尽量用图表描述

2)重构流程图/代码逻辑描述

描述重构代码逻辑,要求清晰准确,尽量用图表描述

3)优化项/改动点

对比重构前后的代码,列举出改进之处和优化之处

4)配置设计

涉及配置的改动

4、测试建议

与需求类一样,这里不再赘述

5、工作量评估

与需求类一样,这里不再赘述


http://www.ppmy.cn/news/1558424.html

相关文章

删除VSCode上 origin/分支名,但GitLab上实际上不存在的分支

如果在 Visual Studio Code (VSCode) 中看到的分支在 GitLab 上实际上并不存在&#xff0c;这通常是因为 VSCode 缓存了旧的远程分支信息。以下是一些步骤来解决这个问题&#xff1a; 更新远程引用&#xff1a; 打开 VSCode 的终端&#xff0c;并运行以下命令来更新远程分支的引…

AAAI-2024 | 大语言模型赋能导航决策!NavGPT:基于大模型显式推理的视觉语言导航

作者&#xff1a;Gengze Zhou, Yicong Hong, Qi Wu 单位&#xff1a;阿德莱德大学&#xff0c;澳大利亚国立大学 论文链接&#xff1a; NavGPT: Explicit Reasoning in Vision-and-Language Navigation with Large Language Models &#xff08;https://ojs.aaai.org/index.p…

Vuex 的使用和原理详解

Vuex 是 Vue.js 的一个专门用于管理应用状态的库&#xff0c;它通过集中式存储和状态管理&#xff0c;使得组件之间可以更加高效地共享数据&#xff0c;同时提供了明确的数据流动机制。 一、什么是 Vuex Vuex 是一个专为 Vue.js 应用程序设计的状态管理模式&#xff0c;采用集…

从 GitLab.com 到 JihuLab.com 的迁移指南

本文分享从 GitLab.com 到 JihuLab.com 的迁移指南。 近期&#xff0c;GitLab Inc. 针对其 SaaS 产品做了限制&#xff0c;如果被判定为国内用户&#xff0c;则会建议使用其在国内的发布版本极狐GitLab。从 GitLab SaaS 产品&#xff08;GitLab.com&#xff09;迁移到极狐GitL…

21、电科院FTU检测标准学习笔记-电磁兼容

作者简介: 本人从事电力系统多年,岗位包含研发,测试,工程等,具有丰富的经验 在配电自动化验收测试以及电科院测试中,本人全程参与,积累了不少现场的经验 ———————————————————————————————————— 目录 静电放电抗扰度试验电快速瞬变…

QtCreator配置github copilot实现AI辅助编程

文章目录 1、概述2、配置环境3、演示 1、概述 新时代的浪潮早就已经来临&#xff0c;上不了船的人终将被抛弃&#xff0c;合理使用AI辅助开发、提升效率是大趋势&#xff0c;注意也不要过于依赖。 2024年12月18日&#xff0c;GitHub 官方宣布了一个激动人心的重大消息&#xf…

wordpress网站用token登入开发过程

生成跳转token 示例&#xff1a; function generate_login_token($user_id, $secret_key) {$payload [user_id > $user_id,timestamp > time(),];$payload_json json_encode($payload);$signature hash_hmac(sha256, $payload_json, $secret_key);return base64_en…

uniapp实现按钮防重复点击(防抖)完整解决方案

需求&#xff1a; 防止用户连续点击按钮&#xff0c;造成短时间内发起多次请求&#xff0c;对后台服务造成压力&#xff1b; 防止第一次请求还没执行完&#xff0c;第二次请求就发起了。 实现方案&#xff1a; 按钮disable禁用定时器按钮恢复 其中定义disable变量主要是为了保证…