研发工程师(RD)需要撰写的设计文档主要分为:总体设计文档 + 详细设计文档,后简称为“总设”+“详设”。
总设和详设都应该包含的部分:
(1) 需求:一般以产品的语言描述,这一块可以拷贝产品需求文档中的story list部分;
(2) 名词解释(可选):非相关领域内的同学需要看到文档需要提前了解的一些概念性质的东西;
(3) 设计目标:又分为功能目标和性能目标,功能目标一般是对产品需求的技术描述,性能目标是根据产品给出的数据对性能进行的评估。一般来说,新服务必须要有性能目标一项,性能目标可能会影响设计方案。
除了都应该包含的部分,总体设计一般还包含:
(1) 系统架构:一般来说会有个简单的架构图,并配以文字对架构进行简要说明;
(2) 模块简介:架构图中如果有很多模块,需要对各个模块的功能进行简要介绍;
(3) 设计与折衷:设计与折衷是总体设计中最重要的部分;
(4) 潜在风险(可选);
输出总体设计的时候,很多方案还是不确定的,需要在设计评审会议上确认。
总体设计重点在“方案折衷”,总体设计评审完毕之后,此时应该是所有方案都确认了,需要输出各模块的详细设计,详细设计重点在“详细”:
(1) 总体设计结论汇总(可选):总体设计上达成一致的结论有个简要概述,说明详设是对这些结论的实现;
(2) 交互流程:简要的交互可用文字说明,复杂的交互建议使用流程图,交互图或其他图形进行说明;
(3) 数据库设计:这个是应该放在总设还是详设呢?
(4) 接口形式:有了数据库+接口+流程,别的同学拿到详设文档,基本也能够搞定了;
(5) 其他细节:例如公式等;
理论上输出了详细设计之后,无论谁拿到了这个详设文档,都是能够完成该项目的。
个人实践分享:
一、 大图
(1) 大系统或复杂流程,其架构图或者流程图会非常大,经常比A4纸或word的一页大很多,此时不宜在word中直接贴图形,贴了也看不清,建议将图放在wiki上,文档中直接贴链接;
(2) 一定要保存viso或者其他图形的源文件,否则今后改动起来要重画,代价可想而知;
二、 设计与折衷
(1) 设计与折衷是总设中最重要的内容,总设评审中,主要就是讨论这些折衷的优劣;
(2) 评审过后,不但要邮件周知结论,还要在总设中进行更新,说明最终决定使用了哪种方案,为什么使用这种方案;根据自己的经验,接手别人的模块、项目,拿到代码和文档,设计方案对我来说完全是个谜!!!
(3) 有时候因为排期或者其他原因,不一定采用了最优的设计方案,此时更应该在总设中记录决策的过程与原因;
(4) 最后,设计折衷是一个很好的自我辩解的机会:因为项目进度,或者历史遗留问题,我不得不采取了一个这样的设计,不要再骂我了。
三、 性能目标
性能目标是新模块文档必不可少的一部分,很多项目对性能影响较大的话,也必须撰写性能目标,性能一般来说可能包含以下部分:
(1) 日平均请求:一般来自产品人员的评估;
(2) 平均QPS:日平均请求 除以 4w秒得出,为什么是4w秒呢,24小时化为86400秒,取用户活跃时间为白天算,除2得4w秒;
(3) 峰值QPS:一般可以以QPS的2~4倍计算;
互联网公司,产品迭代块,项目周期长,基本没有“文档”一说,但其实写好文档,对系统和项目未来的维护是非常有帮助的。
相关推荐
"XX公司xx事业部 "文档编号" "版本"A1 "密级 "商密A" " "项目名称"Xxx系统 " " "项目来源" " DR-RD-020(V1.1) Xxx系统 数据库设计说明书 (内部资料 请勿外传) "编 写: " "日 期:" " "检 查: " "日 期:" " "审 核...
基于P89V51RD2的单片机试验板设计与实现,张雪峰,,P89V51RD2是一款功能非常强大的微处理器。针对项目预研,开发一款基于P89V51RD2的单片机试验板。对试验板进行总体设计,完成硬件设计与
联想ThinkServer RD650, RD550, RD450, RD350, TD350显卡驱动,能够解决在系统安装后,显示分辨率异常问题,适用WindowServer2012~2019。
关爱留守儿童rd文档.doc
SST89E54RD2/RD / SST89E58RD2/RD
RD 算法
雷达成像中最经典的成像算法RD,有完整的代码,便于相关研究者学习
rd450x bmc
课程设计任务书 I 第1章 概述 1 1.1 课程目的 1 1.2 课程内容 1 1.3 课程相关的技术与应用 1 第2章 设计方案及原理框图 3 2.1 相关器件资料 3 2.1.1 单片机SST89E516RD简介 3 2.1.2 LED数码管简介 5 2.1.3 MAX232LED...
适用于ThinkServer RD640, RD540, RD440, RD340, TD340 SAS RAID驱动 此安装包是官方安装包 下载的文件为exe格式的,请直接运行,根据向导提示解压到指定目录,并前往该目录获取驱动文件;
基于P89V51RD2的IAP的设计与实现,马义德,苏梅琴,提出了基于P89V51RD2的IAP编程功能的详细设计,对其实现过程中的要点作了细致阐述,它用来解决产品维护和无人值守区产品升级的问题。
ABAQUS常用界面问题rd文档.pdf
适用于ThinkServer RD640, RD540, RD440, RD340, TD340显卡驱动版本号:6.0.10.98 此安装包是官方安装包 可以在一下系统安装: Windows Server 2008 64位 --------------------------------------------------------...
联想服务器RD540 nvmeBIOS,刷新后可支持NVME,亲测可用通用RD640
适用于ThinkServer RD640, RD540, RD440, RD340, TD340 TCM驱动 此安装包是官方安装包 可以在一下系统安装: Windows Server 2008 32位 Windows Server 2008 64位 Windows Server 2008 R2 Windows Server 2012 ...
Mac 版的RD Client 用于远程桌面登陆其他电脑,支持连接Windows系统
实现单个目标点雷达成像,采用的是RD算法成像
对于初学来说,没有文档没有例子全靠自己摸索实在很费劲。此资料包含MTK官方文档11A_VenusFW_Customization.pdf,以及抓取出其中对应代码,并加以说明,使你能快速上手! 资料包含: 【文件名】:11830@52RD_11A...
ThinkServer-RD350RD450-OS安装手册-V1.0
RD980数字中转台详细介绍及技术参数指标