[总结]软工文档验收

原创 2015年11月18日 09:15:08

       软工文档验收,师傅对我的文档提出了很多需要注意的地方,这里与大家分享一下!

1、预期读者

    在软件工程文档的编辑过程中,每篇开始都要介绍这篇文档的预期读者和编写目的,掌握了每个文档的使用者,我们才能用合适的语言来向不同的人群介绍我们的软件。如果我们一直向将要使用这款软件的老师(一点不懂软件设计)介绍代码的知识,恐怕会适得其反。

2、IPO图

    在介绍软件功能时用到了IPO图,参考了一些文档终于找到了一张像样的图
       
    
     这个链接里面还有很多图的说明,供大家借鉴:

3、接口

   师傅向我提出了这两个问题:接口是如何设计的?你对接口的理解?
   我对接口只有一个广义的理解:不同的语言有不同的接口,接口要简单,方便以后修改。接口用于不同的层之间联系,就像我们用代码去调用数据库中的数据,要用什么样的函数,什么样的方法,怎么声明。。。所以,不同的语言有不同的接口。
   为大家推荐以下的链接:
   软件接口设计指南
   软件接口设计
   抽象类和接口的区别

4、安装过程

   操作手册和用户手册都是写给用户的,我们可以添加一些安装手册到文档中,为用户安装提供便利,以下是安装步骤,大家在平时安装软件的时候都很熟悉了
   通常电脑在安装上stall文件时也会安装上自己的移除文件。
   分为六步:
   ①欢迎使用该软件的讯息提示
   ②阅读终端使用者授权条款(EULA)
   ③选择要安装的组件
   ④选择要安装路径
   ⑤确认配置信息并准备开始安装
   ⑥提示安装完成。

总结:

   软工文档是我们自己写的第一个文档,在最开始接触文档时候要明确每个文档的写作目的,面向的读者,除了安装模板的要求,也要有自己的想法,站在用户的角度,用合适的文字来描述。
    
                 <如有不妥,欢迎指正>


版权声明:本文为博主原创文章,未经博主允许不得转载。 举报

相关文章推荐

《软工文档》总结

首次接触文档,一开始写时,感觉不知道如何下手,就看原文档,按着原文档写,写了几个后,就感觉有点思路了,发现写文档的思路大同小异。以下是我对文档的理解与总结。 首先:弄清楚该文档产生于软件开发的哪个阶...

软工文档——总结

软工文档【总结】 文档有很多的作用,为用户和程序员提供了一个可靠的依据。文档明确规定了各自的职责。 文档 目的 读者 《可行性研究报告》 项目开发人员、开发人员、系统维护人员 ...

精选:深入理解 Docker 内部原理及网络配置

网络绝对是任何系统的核心,对于容器而言也是如此。Docker 作为目前最火的轻量级容器技术,有很多令人称道的功能,如 Docker 的镜像管理。然而,Docker的网络一直以来都比较薄弱,所以我们有必要深入了解Docker的网络知识,以满足更高的网络需求。

软工第一遍文档总结

通过看软工视屏对软件工程有了较为宏观的认识,这两天又趁热打铁按照国标软工文档的要求尝试对之前进行的机房收费系统写了第一份软工文档。个人感觉还是有很多模糊的地方,甚至说是理解错误的地方,不过第一遍也就先...

软工总结——写文档真的重要吗?

今天晚上师傅给我验收软工文档,提到软工文档很重要,确实自己写的也不怎么样,毕竟第一次写都是照着模板和别人思维成品,一点一点磨出来的。有时候不会写了甚至从别人的博客上复制下来一段,写文档这个过程真的很难...

【软工】——软工文档总结

软件工程是系统化开发软件的过程,包括制定计划、需求定义和分析、软件设计、程序编写、软件测试、运行和维护六个步骤,每个步骤的文字性记录就是文档。文档在这里并不只是指导作用,还有说明、记录和总结的作用,它...

软工学习——文档总结(二)

概要设计和详细设计:概要设计是一个设计师根据用户交互过程和用户需求来形成交互框架和视觉框架的过程,其结果往往以反映交互控件布置、界面元素分组以及界面整体板式的页面框架图的形式来呈现。这是一个在用户研究...

软工文档总结

标准的软件开发过程 ,软件开发的标准过程包括六个阶段(瀑布型),而六个阶段需要编写的各类文件达14种之多,在每个阶段需要编写哪些文件?每个阶段都需要画哪种图? 1.可行性与计划研究阶段   可行性...

软工文档总结

经过了一段时间的学习,软工文档写完了,刚开始写文档的时候不知道要怎么去写,但是经过看源文档,慢慢的知道怎么去写文档了。其实写一套完整的文档就是相当于做一个系统的玩

软工文档总结【1】——从门外走进门

软工文档终于在写完了,师傅还没有进行验收,但是我还是想先总结一下我对于文档编写过程中的收货以及一些想法。从软工视频到软工文档,我几乎用时一个月才将它们完成,但是这个项目是我有史以来觉得走的很稳的一个项...

软工文档总结篇(二)

可行性研究报告: 1.系统流程图 系统流程图是描述系统物理模型的工具,基本思想就是用图形符号以黑盒子形式描绘系统的组成,表达信息的流动过程。表达方式是以特定的图形符号加上说明文字加以表示的图。流程图可...
返回顶部
收藏助手
不良信息举报
您举报文章:深度学习:神经网络中的前向传播和反向传播算法推导
举报原因:
原因补充:

(最多只允许输入30个字)