您现在的位置是：首页 > 网站技术问题网站技术问题

一个系统的软件详细设计说明书应该怎么写？

江湖快报网2023-03-20 22:59:27【网站技术问题】人已围观

简介一、前言我们在平常工作中可能会遇到这样的场景，领导跟你讲了我们这个产品大概要做成啥样，然后画了一张简图，就将任务给你，开始出方案设计，需求设计，架构设计，这个时候很多人往往

一、前言

我们在平常工作中可能会遇到这样的场景，领导跟你讲了我们这个产品大概要做成啥样，然后画了一张简图，就将任务给你，开始出方案设计，需求设计，架构设计，这个时候很多人往往会无从下手。最近也算是从0开始写了新平台的任务设计书，有一些感受分享下。

二、进入新行业如何进行快速充电

1、同事领导学习

新进入一个行业，你的同事可能比你更加了解这个行业，所以需要向他们学习，而你的领导肯定是比你了解这个行业的，所以向领导同事多学习。没事找同事聊聊天，找领导请教请教，对快速进入新行业是很有作用的。

2、关注行业自媒体

可以在微信公众号关注一些行业公众号，很多行业都会有行业协会之类的公众号，这种公众号上面的行业资讯是比较多的，还可以关注行业头部企业的公众号，比如新能源就可以关注宁德时代官方公众号。还可以去知乎关注行业的大V，这个很简单，去知乎搜索一下就有了，而且经常关注类似话题，知乎也会给你推荐这方面的内容。 B站上可以找免费的课程学习。行业的论坛，能参加的就参加，参加不了的，可以通过线上的方式或者其他渠道掌握行业一手资讯。

3、适当购买书籍

我的前老板，也是刚进到一个新行业，她就买了大量的书籍，然后加班加点的在看，不管是从提高认知还是对业务的理解成长是非常快的，所以我建议，新进入一个行业，可以多看一些这方面的书籍，并做好总结记录，最好能形成自己的文档沉淀。

4、多参加相关会议

部门会议，项目会议，在不影响本职工作的前提下能参加就去参加，哪怕不发言，就听一些你听不懂的技术点，记录下来，哪里不懂就问请教别人，做好会议记录，多记，多问，多总结。

5、多与同行学习

可以进入同行交流学习群，了解动态，也可以避免一些别人已经踩过的坑。

三、任务书整体框架

1、基本信息 2、背景与目标 3、总体设计要求 4、硬件方案设计 5、软件方案设计 6、应用场景 7、关键节点及费用预算

四、基本信息

展现方案的版本、方案编写时间、撰写人员、评估手段和适用范围

五、背景与目标

背景最好讲一下行业背景和项目背景，包括行业现状和面临的问题，针对这些问题，你的目标是什么？目标写完后，讲一下项目的狠心价值是什么。存在问题这里可以用一些深刻的图片来说明问题。

六、总体设计要求

大体的讲一下总体设计的要求，可以用大图表现更清晰，讲一讲平台的特性。 1、软件项目的开发实施过程管理要求包含总体要求和软件变更要求及实施里程碑控制

七、硬件方案设计

1、预估下数据存储量

评估的方案每个行业不一样，可进行有效性评估

2、服务器选型

2.1、服务器上运行的应用

在这里插入图片描述

2.2、需要支持的用户访问数量

预计将有多少个注册用户，正常情况下多少个用户会同时在线访问，每天同时在线访问的最高峰值大概是多少个，未来的用户增长情况如何。

2.3、需要存储数据的空间大小

在这里插入图片描述

2.4、服务器参数

在这里插入图片描述

2.5、物理服务器对比

2.5.1、塔式服务器优势：主板扩展性较强，插槽很多，成本较低，性能能满足大部分中小企业用户的需求。局限性：个体较大，占用空间多，不便管理，噪音大适用场景：可以用于公司内部测试环境

在这里插入图片描述

2.5.2、机架式服务器优势：节省空间，便于统一管理局限性：扩充性受限制，散热性能，单机性能比较有限，价格贵于塔式服务器适用场景：服务器数量较多的大型企业适用，密集部署需求

在这里插入图片描述

2.5.3、刀片式服务器优势：节省空间，便于集中管理局限性：散热问题，价格贵适用场景：特殊应用行业和高密度计算机环境适用，大型数据中心

在这里插入图片描述

2.6、云服务器对比

云服务器目前主流有阿里云、腾讯云、华为云，针对这三家做一下综合对比。

在这里插入图片描述

价格对比：

在这里插入图片描述

云厂商详细配置价格表

选择对比图表

在这里插入图片描述

2.7、物理服务器何云服务器对比

在这里插入图片描述

2.8、服务器选型的方案

这里最终确认最终服务器选型的方案

八、软件方案设计

1、综合描述

介绍用户类和特性、运行环境、设计和实现上的限制

在这里插入图片描述

2、外部接口需求

这里主要描述用户界面、软件接口、通讯接口等信息

在这里插入图片描述

3、系统功能需求

描述说明和优先级、功能需求效果图、激励／响应序列、输入/输出数据，可以适当用图画出

4、其他非功能的需求

性能需求：

在这里插入图片描述

安全措施需求：

在这里插入图片描述

软件的质量属性：

在这里插入图片描述

业务规则和用户文档的描述。

5、数据定义

进行数据的定义

6、分析模型

可以通过模型进行分析

7、软件的概要设计

描述软件概要设计

8、软件的详细设计

如果概要设计无法满足的需要进行软件的详细设计

9、软件的编码

为了提高编程实现的质量，软件的程序设计必须遵照国家颁布的相关编程规范。主要内容包括：规范化的程序内部文档、数据结构的详细说明、清晰的语句结构、编码规范。编码规范的内容包括命名规范、界面规范、提示及帮助信息规范、热键定义等。在软件编码的同时应进行单元测试。

10、软件的测试

为了尽早发现软件产品中的错误，从而达到提高软件质量、降低软件维护的费用，开发者应在编码过程中对各个模块的程序代码进行单元测试，系统集成时进行集成测试，系统集成完成后对整个软件进行系统测试。单元测试是在软件开发过程中针对程序模块进行正确性检验。集成测试是在单元测试的基础上，将所有模块按照设计要求组装成系统或子系统，对模块组装过程和模块接口进行正确性检验。软件系统测试不仅是检测软件的整体行为表现，从另一个侧面看，也是对软件开发设计的再确认。进行软件系统测试工作时。测试主要包括界面测试、可用性测试、功能测试、稳定性(强度)测试、性能测试、强壮性(恢复)测试、逻辑性测试、破坏性测试、安全性测试等。开发者针对单元测试，集成测试，系统测试分别制定《测试计划》。集成测试需要根据需求分析报告和概要设计制作测试用例，并须经过评审。软件测试按照《测试计划》、《需求分析报告》的要求进行，最后形成《软件测试报告》。

11、软件的交付准备

可以写交付清单：在软件测试证明软件达到要求后，软件开发者应向公司提交开发的目标安装程序、数据库的数据字典、《用户安装手册》、《用户使用指南》、需求报告、设计报告、测试报告等双方合同约定的产物。《用户安装手册》应详细介绍安装软件对运行环境的要求、安装软件的定义和内容、在客户端、服务器端及中间件的具体安装步骤、安装后的系统配置。《用户使用指南》应包括软件各项功能的使用流程、操作步骤、相应业务介绍、特殊提示和注意事项等方面的内容，在需要时还应举例说明

12、软件的鉴定验收

在软件开发完成后，为了确保软件是按照需求分析的要求进行开发的，保证软件产品的质量，需要对软件产品进行鉴定验收。在开发者如期交付软件后，由公司大数据中心负责确定具体的鉴定验收日期。验收的具体内容：验收内容应该包括：合法性检查、文档检查、软件一致性检查、软件系统测试与测试结果评审等几项工作。合法性检查检查软件开发工具是否合法、使用的函数库、控件、组件是否有合法的发布许可。文档检查检查开发者提交的文档必须齐全，质量是否过关。需要开发者提供的文档包括：项目实施计划；详细技术方案；软件需求规格说明书(STP)(含数据字典)；详细设计说明书(DDD)(含数据库设计说明书)；软件测试报告(STR)；用户手册(SUM)(含操作、使用、维护、应急处理手册)；源程序(SCL)(不可修改的电子文档)；软件质量保证计划(SQAP)；此外，验收组可以根据需要对其它文档(如软件配置计划、项目进展报表、阶段评审报表等)进行检查。文档的质量根据完备性、正确性、简明性、可追踪性、自说明性、规范件等方面进行踪合评定。验收需要对软件代码进行检查，以确保其符合规范，并检查其一致性。