首页 » 技术资讯 » 项目开发(程序)的必要文档需要哪些?(模块看了项目设计描述)

项目开发(程序)的必要文档需要哪些?(模块看了项目设计描述)

雨夜梧桐 2024-07-23 22:59:29 技术资讯 0

扫一扫用手机浏览

文章目录 [+]

通常文档是由产品经理/需求分析师负责编写,如果没有,项目组成员也可编写一个需求沟通说明书,如果是新来的同学看到这个文档,会比较容易理解项目要做什么。

二、业务流程序列图

体现整个系统的模块及相互间的业务上下游关系,通常会是UML的方式,不谈具体的技术方案,主要是根据需求说明做功能设计。

项目开发(程序)的必要文档需要哪些?(模块看了项目设计描述) 项目开发(程序)的必要文档需要哪些?(模块看了项目设计描述) 技术资讯
(图片来自网络侵删)

三、接口设计文档

描述对外提供的API的输入输出;用户看了知道怎么用,开发看了知道每个API内部要怎么做。

项目开发(程序)的必要文档需要哪些?(模块看了项目设计描述) 项目开发(程序)的必要文档需要哪些?(模块看了项目设计描述) 技术资讯
(图片来自网络侵删)

四、数据模型设计

描述系统用到的存储层Schema(数据结构)或内部节点之间通讯协议等。
二、三、四加一起可以叫做功能设计说明书。

五、技术架构设计

描述模块的划分,以及模块之间的关系;模块之间如何协作,以及重点或过程的具体技术思路。
技术设计可以是描述整体、局部重点的模块也可以单独出一个更为详细的内部模块设计。

六、物理部署图

通常是与整体架构图之间的对应,标注这个系统每一台服务器,网络等设备的位置、角色、参数配置等,以后运维人员看了这个图就知道当初是如何部署搭建的;问题诊断根据这个图更容易发现问题,特别是系统容量的问题。

其他.............#程序员##深圳##北京##上海##项目开发##架构##干货##工作##职场#

标签:

相关文章