对于文档的总结,本该在软工之后,文档书写完后进行的。可之前,对于文档的书写没有多少感觉。师傅检查了一遍我的文档,并对文档存在的问题及我的情况进行了分析,让我重新改一改。这一遍,让我对文档有了很多新的认识。

为什么要写文档?

这可能是很多人都想要问的一个问题。为什么要写文档呢?前前后后,那么琐碎,那么麻烦,要是想研究个什么方案,大家开个会,当面研究、解答不是更好?看似想法不错,其实不然。或许,我们的前辈也看得到,也知道写文档很麻烦,可为什么还是要写呢?第一,文档不只是给开发人员看的。可能开发人员对于软件自身了解的非常多,可对于从未接触过软件的呢?有时候,你不觉得文档就像药品或者手机等电子产品的说明书吗?买药时,不了解药性,不知道吃药需不需要忌口,不知道药品有没有副作用,孕妇、儿童是不是不能吃,药量是多少,等等诸如此类的问题,有个说明书,那一切不就迎刃而解了?第二,文档可以指出一个既定的目标,让设计团队朝着那个方向走,不至于跑偏,这对于整个设计团队来说,具有指导作用。第三,要知道,有很多项目是需要合作开发的,一个人是独立完成不了的。一大堆人聚集在一起,要各司其职的把自身任务完成好,再将各自所属的任务“组装”在一起,形成一款优秀的软件,这个过程是何其的艰难。当很多人聚集在一起,力量是很大,但是思想也开放,如果每个人都按照各自的想法去进行,那么到最后,开发出来的软件与最初的设想,很可能就大相径庭了。

文档要达到什么要求?

可能之前对文档从未接触过,也不熟知它的作用及含义。文档要达到什么要求呢?什么样的文档才是合格的呢?简单来说,就是你拿到文档,照着文档,你能敲出与文档描述相匹配的软件。那样的文档才是合格的。仔细比对你下,你写的文档合格吗?

我的收获、经验总结

这一遍对文档的更改,让我收获很多。之前,就是把文档的模板拿来,不分主次,不分重点,“一视同仁”地“照葫芦画瓢”。结果,文档中,该重点写的地方没写好,不该重点写的也那么糊里糊涂的写过去。写文档时,一定要抓住重点,要分清要具体的文档哪部分是不能忽视并且应该重点对待的,这才是写文档的关键。

写文档重点要注意的地方:在这里挑几个主要的说一下。比如说写概要设计说明书时,什么地方要重点对待呢?一听是概要设计,当然要在文档中,能描述出整个系统的大致轮廓,这才是最重要。因此,系统概述、软硬件平台和系统的网络体系结构是至关重要的。详细设计说明书中,要在概要设计说明书的基础上,重点将功能细化描述。例如在机房收费系统中,是如何实现上机操作的?要进行刷卡上机或输入卡号按上机按钮进行上机,输入卡号时要求的数字长度、字符规范、卡号如何获取等等,细化到一个小功能如何实现都不放过。详细设计文档,是给程序员看的。要让从未接触过系统的程序员,根据详细设计文档就能写出代码,那么你写的详细设计文档才算是合格的。在数据库设计中,重点在于要详细的写出表的属性,其中包括各个表名、每个表下面对应的列名,中文注释、数字类型、长度、是否为空,是否主键、是否外键等等。在需求分析文档中,要重点分析产品面向的最终客户人群的需要及此人群对软件性能、品质的需要等。总之,要从用户的自身出发,开发适用于最广大用户需求的软件,才是最成功的软件。用户手册中,要重点描述如何使用系统即具体的操作步骤。因为用户手册是给用户看的,它就像一个说明书,是给用户使用时的一个指导。要让用户知道输入什么,点击什么,能完成哪些功能等。只有用户看得明白,才能保证操作。

以上,对于文档的分析就写到这里。对于文档的学习,随着学习的深入,以后有发现新的、好的想法,会及时更新到博客中,欢迎大家多提宝贵意见,我们共同进步!

如何写软件设计文档?相关推荐

  1. 如何写出一份优秀的软件设计文档

    作为一名软件工程师,我花了很多时间阅读和编写设计文档.在完成了数百篇这些文档之后,我亲眼目睹了优秀设计文档与项目最终成功之间的强烈关联. 本文试图描述什么使设计文档变得更好. 本文分为4个部分: · ...

  2. 如何才能写出好的软件设计文档?

    作为一名软件工程师,我花了很多时间在阅读和撰写设计文档上.在磨砺了数百篇文档之后,我发现,优秀的设计文档与项目的成功之间有着密切的联系. 这篇文章将介绍怎样才能写出一份优秀的设计文档. 为什么要写设计 ...

  3. 局域网聊天软件 设计文档怎么写?

    局域网聊天软件 设计文档怎么写?这种针对数据库记录的 局域网聊天软件 窃取,被一些攻击者称为拖库,于是有了一个自然而谐音的戏称脱裤.只是攻击者日趋不厚道,从前只是偷了人家的裤子,现在还要晾在大街上,并 ...

  4. 【译】如何写出一份优秀的软件设计文档

    作为一名软件工程师,我花了很多时间阅读和编写设计文档.在完成了数百篇这些文档之后,我亲眼目睹了优秀设计文档与项目最终成功之间的强烈关联. 本文试图描述什么使设计文档变得更好. 本文分为4个部分: 为什 ...

  5. 如何从数据库中筛选出达成指定里程碑节点的项目_【译】如何写出一份优秀的软件设计文档...

    作为一名软件工程师,我花了很多时间阅读和编写设计文档.在完成了数百篇这些文档之后,我亲眼目睹了优秀设计文档与项目最终成功之间的强烈关联. 本文试图描述什么使设计文档变得更好. 本文分为4个部分: 为什 ...

  6. 软件设计文档如何编写,设计文档内容都包括什么

    我们经常听到这样的话: "设计文档没有用,是用来糊弄客户和管理层的文档": "用来写设计文档的时间,项目开发早就做完了": "项目紧张,没有时间做设计 ...

  7. SCADE Display(OpenGL)软件设计文档生成工具的设计考虑

    SCADE Display(OpenGL)软件设计文档生成工具的设计考虑 2018年6月 1 引言 本文档描述在SCADE Display软件设计文档生成工具(以下简称为SDYSDDGEN)的设计过程 ...

  8. 一般性网络错误 请检查网络文档_如何编写好的软件设计文档

    原文链接 作为一名软件工程师,我花了很多时间阅读和编写设计文档.在研究了数百篇这样的文档之后,我发现好的文档与项目成功之间有很强的关联性. 在本文中,我尝试去说明如何才能编写好的设计文档. 本文分为4 ...

  9. 如何编写一个好的软件设计文档

    作为一名软件工程师,我花了很多时间阅读和编写设计文档.在完成了数百篇这些文档之后,我亲眼目睹了优秀设计文档与项目最终成功之间的强烈关联. 本文试图描述使设计文档变得更好的原因. 本文分为4个部分: 为 ...

  10. 软件设计文档国家标准

    转自:http://blog.sina.com.cn/s/blog_62bb1dbe0100qlj9.html 操作手册(GB8567--88) 1引言 1.1编写目的 说明编写这份操作手册的目的,指 ...

最新文章

  1. asp.Net Core免费开源分布式异常日志收集框架Exceptionless安装配置以及简单使用图文教程...
  2. 地球自转减速影响世界时 格林尼治时间或成历史
  3. 阿里菜鸟知识储备之二——git工具学习
  4. ajax 导致 css 延迟_AJAX远离404
  5. P2324 [SCOI2005]骑士精神(迭代加深搜索,dfs)
  6. Spring定时器的运用
  7. 解决no such file or directory的问题
  8. vue项目实战环境的搭建 -- 项目创建及连接github(gitee同理)
  9. oracle 2500varchar,Oracle中的varchar和varchar2有什么区别?
  10. 【转】3DSMax各个版本的下载地址
  11. SourceTree这是一个无效源路径(更改git账号和密码导致无效源路径看这里)
  12. 微信连WiFi(sign有误)
  13. c++ RMI demo(使用RCF库)
  14. 苹果CMS绑定分类失败,刷新就丢失!
  15. 木材材积表快速计算器_木材材积表计算器
  16. Week12—最大匹配括号数
  17. IDM下载器:站点抓取相关设置介绍
  18. 第一周 平面点的对称点
  19. 集算器入门之安装与基本使用
  20. 文本预处理的一些知识

热门文章

  1. Python编写的疲劳检测系统(实时摄像头检测)
  2. 劳务派遣计算机信息管理系统,劳务派遣人员信息管理系统
  3. 某新闻App sign签名算法解析(一)
  4. Android免费加固加壳加密
  5. ATX电源接口, 服务器插拔电源接口
  6. 智能建筑现状及发展趋势,建筑智能化的发展趋势
  7. ROS时钟--支持时间倒计时小工具
  8. java 基础复习
  9. 自学的程序员如何找到好工作?
  10. openwrt编译smartdns_LEDE/OpenWRT 部署SmartDNS