前言:

昨晚顺利的完成了机房收费系统第一遍文档的验收,验收过程中对于各个文档之间的联系、功能、重要性,师傅和我一同做了分析,又经过查阅网上的资料、和身边实习的实习的师哥师姐的交流以及自己的思考,我想把整个文档做个总结,方便在UML以及做以后的系统时文档的编写。

如图是软件工程文档的模板:

总共12个文档,看起来毫无头绪,照着顺序写吧,写完之后仍然一头雾水,可是想要给这12个文档撒一点魔术粉串起来整体做一下把控,就得归归类,排排序了。As illustrated in this picture:

如图所示,把整个过程12个文档分成5个阶段:准备、计划、设计、测试、总结,文档的撰写我理解总体就是按着这个顺序,其中小的标号为样本文档中文档的顺序,粉色(or紫色)的地方是我认为比较重要的几个阶段,同时此处需要说明:

(1)图中未画出用户手册和操作手册,因为这两个文档的编写是贯穿在其他文档之间的,就像操作手册,In my opinion,从概要设计阶段就要开始写的,贯穿到文档的结束。So,这一点需要说明。

(2)编写顺序,样本文档中在《项目开发计划》后才进行《需求说明》,开始我也是这样理解的,但是在昨晚和师傅讨论的时候师傅帮我纠正了一下,就像如果都不知道用户究竟想要干什么,怎么做计划?凭空去想?要知道每个系统的侧重点都是不一样的,侧重不一样,系统开发过程中时间、人员的分配就会不同,so,往往先进行完《需求说明书》后才开始《开发计划》,同时也想参加过实习的师姐请教了,正规点的公司就是这样,小公司往往身兼数职。

(3)这个图侧重了文档的编写顺序,对于各个文档之间的联系基本上没有表现(画图能力有待提高),主要是自己只写了一次文档,对于文档的理解程度还不高。

接着简单说明几个文档之间的关系:

(1)《操作手册》、《用户手册》,在写这两个文档的时候脑子里一头雾水,究竟他们的区别在哪里?开始我的理解,前者注重于系统操作步骤的介绍,后者除了操作步骤,还有系统的性能、功能、运行环境、易出错的地方等的说明,更加详细一点。

我上网查了一下:“操作手册是系统级别的文档,而用户手册是需求级别的文档。操作手册讲述的是如何操作该系统的某个页面(你可以根据系统的菜单,一个一个的讲述它的操作按钮),而用户手册是在用户想做什么事情,在这样的前提下引导用户去操作该系统完成这样的需求(比如可以写个使用快速入门的小手册,把常规的使用写好:要实现什么功能要怎么操作),在做项目的时候一个操作手册可以代替用户手册,因为各方面的需求很明确。”难怪师傅说这两个文档可以写成一个文档。

(2)设计阶段的四个文档:把《概要设计》比作骨架、《详细设计》就是往骨架上添血添肉,而《数据库的设计》和《数据要求说明书》就可以比作成不断支持着身体细胞新陈代谢的器官和血管,有了他们,数据便可以在各个模块、功能之间来回调用。

(3)一旦用户的需求发生了变化,可能仅仅是一个小小功能的添加、修改,便会对其他文档的编写执行造成影响,但是只要是按着上面分的这五个阶段逐次来尽心分析,即使需求变动很大,对于我们做出这个系统的影响也会降到很低。

All in all,软件工程是为了更高效的进行软件开发,文档则是软件工程思想的一个很好的体现形式,把握好软件工程各个阶段核心思想,文档的撰写就不至于跑偏,软甲的开发才会更加的高效。

软件工程----第一遍机房文档之串思路相关推荐

  1. 软件工程 学习管理系统 需求分析文档

    软件工程 学习管理系统 需求分析文档 [摘要] 学生学习管理系统是学生管理的一个重要组成部分,也是学校管理的组成部分.尤其是在信息技术高度发达的今天,利用信息技术实现高效的校园学习管理有着巨大的实用价 ...

  2. 【软件工程】VB版机房文档总结

    前言: 软工视频+软工文档+UML视频+UML图的学习过程图! 这部分的知识很厚,只是知道了个大概!最开始 慢悠悠的像个老爷爷走进度,后来遇到点什么事,妈呀,管不了那么多了,赶紧弄完在说,拖了多久了都 ...

  3. MFC(文档和串行化,孙鑫C++第十三讲笔记整理) .

    转自:http://blog.csdn.net/zh634455283/article/details/7882897 1.CArchive在菜单打开保存时的代码  CFile file(" ...

  4. 【软件工程】--软工文档总结

    背景 看完了软工视频后很是兴奋,然后如饥似渴的开始了软工文档的学习,但是看了培养计划后感觉还是一头雾水. 于是就去找了四五个小伙伴交流,他们毕竟是写过文档了,有一些经验.经过和他们的交流,我渐渐觉得这 ...

  5. H3C 思科华为 等网络设备配置文档自动备份思路及实现方法

    网络设备一般包含交换机.路由器.防火墙 H3C .思科.华为网络设备都可以使法这个方法自动备份配置文档 一般情况下我们是更新网络设配置,然后手动导出配置文档,save到一个指定目录,这种方式网络设备数 ...

  6. 软件工程---个人账本---立项文档

    1 可行性分析 1-1 主要功能要求 实现用户登录和注册功能,保护用户的相关隐私,每次使用需要使用密码登录 实现基础记账功能,用户可以添加记账信息:日期.数目.用途.备注等信息 实现进阶功能:自动生成 ...

  7. 第一次写需求文档的心酸历程

    先划重点: 功能需求 就是把具体的用户需求,变成软件的功能要求. 比如客户要把交通事故照片通过app发给保险公司.这是用户需求. 那么功能需求就是在这个模块下,要具有提交报险事故照片功能,上传现场照片 ...

  8. python实现word文档批量转成自定义格式的excel文档

    python实现word转成自定义格式的excel文档(解决思路和代码) 支持按照文件夹去批量处理,也可以单独一个文件进行处理,并且可以自定义标识符 最近在开发一个答题类的小程序,到了录入试题进行测试 ...

  9. matlab怎么定义矩阵变量_matlab文档(一)matlab入门

    距离上一篇文章的发布有一个多月了.现在接上,来分享一些MATLAB软件的内容,同时自己也来更加深入地学习这个软件. 01 前言 网上的学习视频很多了,我就从matlab官网的文档(2019a版)入手, ...

最新文章

  1. 1数字图像获取:1.2图像灰度直方图
  2. Docker的使用(五:Docker中的网络与数据管理)
  3. 最近的特别问题(1)
  4. Python多版本共存配置
  5. 单链表的python实现
  6. python3 的windows下文件操作注意问题
  7. 【转】静态类与非静态类
  8. 比特飞使用的是什么主题
  9. 音乐播放器界面如何设计?
  10. List 中的元素排序
  11. Oracle数据同步接口中,对于NUMBER、DATE类型数据,从resultSet中直接获取造成精度丢失的解决方案
  12. opencv 学习第二课 摄像头、外部视频读取、处理、显示、写入 代码注释版 保证你每一行都能读懂
  13. 原创:CSS3技术-雪碧图自适应缩放与精灵动画方案
  14. 蓝懿iOS培训日志22 图册
  15. ecplise tomcat忽然出现404
  16. Node版本管理控制器n
  17. 手机版支付宝html页面,支付宝手机网页支付代码
  18. 磁盘显示无法访问数据错误循环冗余检查的资料恢复法子
  19. 鸿蒙系统上海,鸿蒙系统助阵 华为新一代智慧屏升级五大分布式场景
  20. nand falsh 111

热门文章

  1. 设计模式-备忘录模式(快照模式)
  2. 基于R的FP树fp growth 关联数据挖掘技术在煤矿隐患管理
  3. kylin v10系统_Kylin10正式版 银河麒麟桌面操作系统(Kylin) V10 x86/兆芯版/海光版下载-520下载...
  4. 【Unity】DnSpy断点调试Unity已发行游戏的dll
  5. 网络综合测试仪 都具备什么功能
  6. pathway common:综合性的pathway数据库
  7. 关于硬件工程师的真相:敢问路在何方?
  8. 解决git pull时出现的几个问题
  9. 如何在华为云软件开发云上运行Python
  10. 英语阅读小程序云开发项目