研发工程师(RD)需求 撰写的设计文档次要 分为： 整体 设计文档 + 具体 设计文档，后简称为“总设”+“详设”。

　　总设和详设都应当 包括 的局部 ：

　　(1)需求：普通 以产物 的言语 描写 ，这一块可以拷贝产物 需求文档中的story list局部 ;

　　(2)名词注释 (可选)：非相干 范畴 内的同窗 需求 看到文档需求 提早 懂得 的一些概念性质的器材 ;

　　(3)设计方针 ：又分为功效 方针 和功能 方针 ，功效 方针 通常为 对产物 需求的手艺 描写 ，功能 方针 是依据 产物 给出的数据对功能 停止 的评价 。普通 来讲 ，新办事 必需 要有功能 方针 一项，功能 方针 能够 会影响设计计划 。

　　除 都应当 包括 的局部 ，整体 设计普通 还包括 ：

　　(1)体系 架构：普通 来讲 会有个复杂 的架构图，并配以文字对架构停止 扼要 申明 ;

　　(2)模块简介：架构图中假如 有良多 模块，需求 对各个模块的功效 停止 扼要 引见 ;

　　(3)设计与折中 ：设计与折中 是整体 设计中最主要 的局部 ;

　　(4)潜伏 风险(可选);

　　输入 整体 设计的时分 ，良多 计划 仍是 不肯定 的，需求 在设计评审会议上确认。

　　整体 设计重点在“计划 折中 ”，整体 设计评审终了 以后 ，此时应当 是一切 计划 都确认了，需求 输入 各模块的具体 设计，具体 设计重点在“具体 ”：

　　(1)整体 设计结论汇总(可选)：整体 设计上告竣 分歧 的结论有个扼要 概述，申明 详设是对这些结论的完成 ;

　　(2)交互流程：扼要 的交互可用文字申明 ，庞杂 的交互建议利用 流程图，交互图或其他图形停止 申明 ;

　　(3)数据库设计：这个是应当 放在总设仍是 详设呢?

　　(4)接口模式 ：有了数据库+接口+流程，其余 同窗 拿到详设文档，根基 也可以 弄 定了;

　　(5)其他细节：例如公式等;

　　实际 上输入 了具体 设计以后 ，不管 谁拿到了这个详设文档，都是可以 完成该项目标 。

　　团体 理论 分享：

　　1、 大图

　　(1)大体系 或庞杂 流程，其架构图或 流程图会十分 大，常常 比A4纸或word的一页大良多 ，此时不宜在word中直接贴图形，贴了也看不清，建议将图放在wiki上，文档中直接贴链接;

　　(2)必定 要保留 viso或 其他图形的 源文件，不然 从此 修改 起来要重画，价值 可想而知;

　　2、 设计与折中

　　(1)设计与折中 是总设中最主要 的内容，总设评审中，次要 就是会商 这些 折中 的好坏 ;

　　(2)评审事后 ，不仅 要邮件周知结论，还要在总设中停止 更新，申明 终究 决意 利用 了哪一种 计划 ，为何 利用 这类 计划 ;依据 本人 的经历 ，接办 他人 的模块、项目，拿到代码和文档，设计计划 对我来讲 完整 是个谜!!!

　　(3)有时分 由于 排期或 其他缘由 ，纷歧 定采取 了最优的设计计划 ，此时更应当 在总设中纪录 决议计划 的进程 与缘由 ;

　　(4)最初 ，设计折中 是一个很好的自我辩护 的时机 ：由于 项目进度，或 汗青 遗留成绩 ，我不能不 接纳 了一个如许 的设计，不要再骂我了。

　　3、 功能 方针

　　功能 方针 是新模块文档必不成 少的一局部 ，良多 项目对功能 影响较大的话，也必需 撰写功能 方针 ，功能 普通 来讲 能够 包括 以下局部 ：

　　(1)日均匀 恳求 ：普通 来自产物 人员的评价 ;

　　(2)均匀 QPS：日均匀 恳求 除以 4w秒得出，为何 是4w秒呢，24小时化为86400秒，取用户活泼 工夫 为日间 算，除2得4w秒;

　　(3)峰值QPS：普通 可以以QPS的2~4倍盘算 ;

　　互联网公司，产物 迭代块，项目周期长，根基 没有“文档”一说，但其实写好文档，对体系 和项目将来 的保护 长短 常有匡助 的。

如果是简单的产品组合出现，产品之间优势互补，是最简单而直接的方法，但是估计海尔的空气圈应该没这么简单。”