[总结]软工文档验收

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

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

1、预期读者

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

2、IPO图

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

3、接口

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

4、安装过程

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

总结:

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


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

App功能测试总结(一)

APP的发展在软件行业非常的迅速,但是APP给用户带来的体验以及软件质量的本身还是存在很多的不足。 APP测试也随之发展起来,但是在具体的质量要求上还是没有一定的规范要求。 借鉴前辈们的测试经验汇...
  • Yejianyun1
  • Yejianyun1
  • 2016年06月25日 11:43
  • 3696

【软件工程】写文档真的很重要——文档总结

最近
  • u012904383
  • u012904383
  • 2014年08月02日 11:44
  • 2090

手机APP项目测试点总结

手机APP项目测试点总结
  • huwei2003
  • huwei2003
  • 2016年08月19日 15:00
  • 6573

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

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

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

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

软工文档总结篇(二)

可行性研究报告: 1.系统流程图 系统流程图是描述系统物理模型的工具,基本思想就是用图形符号以黑盒子形式描绘系统的组成,表达信息的流动过程。表达方式是以特定的图形符号加上说明文字加以表示的图。流程图可...
  • tigaoban
  • tigaoban
  • 2016年11月01日 20:26
  • 290

【软工学习】文档总结

软件文档是非常重要的,要记录软件工程师对程序的设计思路,并且让以后对该软件进行维护的人员可以明白清楚的了解这个软件,上面是说针对后来维护人员的软件文档,除了这个以后还有针对用户的软件文档,就像电视机的...
  • u013035612
  • u013035612
  • 2014年10月21日 00:01
  • 1756

软工文档总结

软件工程最后的那些总结与收获,和大家分享.
  • u013030601
  • u013030601
  • 2014年11月16日 14:56
  • 1027

【软工视频】软工文档总结

文档总结也写完了,这一系列的博客记录了我学习软工的每一个脚印。在这个过程中,我知道了软件工程的巨大作用,我明白了总结的重要性,我懂得了坚持是多么难得可贵!这只是我学习旅途中的一个站点,我期待下一站的更...
  • u013036092
  • u013036092
  • 2014年12月14日 15:34
  • 1189

软工之软工文档总结(二)

继续软工文档的总结~
  • sulu0416
  • sulu0416
  • 2016年12月25日 21:17
  • 282
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:[总结]软工文档验收
举报原因:
原因补充:

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