软件设计文档怎么写

一份好的设计文档需要提供清晰的问题描述、整体的概要设计、涵盖各个细节的详细设计等。

在成熟的互联网公司,文档被用来讨论问题、作为真实的信息源、组织知识。

一周一志

下面我们来看一下具体的文档结构和内容考量维度。

一、问题描述

背景

痛点

想解决什么问题

二、需求

想要考虑什么:(需要做的点)

哪些需求点不在考虑范围内:(即此次无需做的点)

第三方挂了

地震起了网络波动

下大雪断电了

程序员饿了=。=!!!

三、概要设计

初步方案对比优缺点,确定方案

系统概述

四、详细设计

怎么实现

怎么实现

怎么实现

怎么实现

实现

.....

更多的实现细节

五、操作流程

何时执行?

如何使用?

注意事项?

怎样确认是否成功?

以上就是软件设计书的基本结构。

写设计文档,具体内容可以参考以下维度和方向:软件质量模型的6大特性:

一、功能性(Functionality):一组功能及其指定的性质有关的一组属性。适合性、准确性、互用性/互操作性、依从性、安全性。

二、可靠性(Reliability):在规定的一段时间和条件下,软件维持其性能水平有关的一组软件属性。成熟性、容错性、易恢复性。

三、可用性(Usability):与使用的难易程度及规定或隐含用户对使用方式所做的评价有关的软件属性。易理解性、易学性、易操作性。四、效率性(efficiency):在规定条件下,软件的性能水平和所用资源之间的关系有关的一组软件属性。时间特性、资源特性。

五、可维护性(maintainability):与进行指定的修改所需的努力有关的一组软件属性。易分析性、可修改性、稳定性、可测试性。

六、可移植性(Portability):与软件可从某一环境转移到另一环境的能力有关的一组软件属性。适应性、易安装性、一致性(遵循性)、可替换性。

UML图UML图

语言是最苍白无力的,如何让设计文档更充实更丰满更充满活力——上图。软件设计中UML中包括13种图,分别为用例图、类图、对象图、状态图、时序图、协作图、活动图、组件图、配置图9中,包图、组合结构图、交互概览图3种。。常见的UML图有用例图(UseCaseDiagram)、类图(ClassDiagram)和时序图(SequenceDiagram),可以主要阐述这三种UML图。

设计模式六大原则#程序员的闲暇时光#

设计模式的目的设计模式是为了更好的代码重用性,可读性,可靠性,可维护性。

常用的6大设计模式单一职责原则里氏替换原则依赖倒转原则接口隔离原则迪米特法则开闭原则

写在最后来首林子祥的歌激励自己:长路漫漫任我闯,带一身胆色和热肠,找我自我和真情,停步处便是家乡。



转载请注明地址:http://www.yujinxiangqiangzhi.com/rjlc/rjlc/17614.html


  • 上一篇文章:
  • 下一篇文章: 没有了
  • 公司简介 广告合作 发布优势 服务条款 隐私保护 网站地图 版权声明