[总结]软工文档验收

简介: [总结]软工文档验收

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


1、预期读者


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


2、IPO图


在介绍软件功能时用到了IPO图,参考了一些文档终于找到了一张像样的图

20151118093250737.jpg


这个链接里面还有很多图的说明,供大家借鉴:


3、接口


师傅向我提出了这两个问题:接口是如何设计的?你对接口的理解?

  我对接口只有一个广义的理解:不同的语言有不同的接口,接口要简单,方便以后修改。接口用于不同的层之间联系,就像我们用代码去调用数据库中的数据,要用什么样的函数,什么样的方法,怎么声明。。。所以,不同的语言有不同的接口。

  为大家推荐以下的链接:

    软件接口设计指南

  软件接口设计

  抽象类和接口的区别


4、安装过程

操作手册和用户手册都是写给用户的,我们可以添加一些安装手册到文档中,为用户安装提供便利,以下是安装步骤,大家在平时安装软件的时候都很熟悉了

  通常电脑在安装上stall文件时也会安装上自己的移除文件。

分为六步:

①欢迎使用该软件的讯息提示
  ②阅读终端使用者授权条款(EULA)
  ③选择要安装的组件
  ④选择要安装路径
  ⑤确认配置信息并准备开始安装
  ⑥提示安装完成。


总结:

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

相关文章
|
6月前
软件交付问题之为什么在完成设计评审后需要将明确的项目计划同步给需求发起人
软件交付问题之为什么在完成设计评审后需要将明确的项目计划同步给需求发起人
|
8月前
|
测试技术 项目管理
什么是测试管理审查和审核?
什么是测试管理审查和审核?
|
8月前
|
监控 测试技术 调度
测试管理流程有哪些?
测试管理流程有哪些?
128 0
|
安全 API 数据库
陈伟视频验收总结
陈伟视频验收总结
84 0
|
测试技术 程序员 数据库
软工文档第一次验收
软工文档第一次验收
72 0
|
搜索推荐 测试技术 UED
需求评审那些事
需求评审那些事
|
测试技术
关于需求评审和讲解的一些思考
上图为[产品迭代开发协作流程],上次聊了一下关于 Code Review 的一些思考。 在上面的流程中,需求评审通过后,要产出最终的需求文档、原型等交付物,还要对本次需求封版;在测试阶段的补充需求的处理方式;上线后记录或反馈的问题列入下一版的迭代。 可是,流程中都是比较理想的状态,现实工作中并没有达到设想的目标。作为一个开发人员,分别站在产品经理的角度和开发人员的角度分析一下问题的可能原因。
|
人工智能 自然语言处理 运维
如何让评审人爱上我
今天小编作为一个开发者,放下外部的客观因素,仅从一个代码的实现者,一个被评审人的角度去思考如何让评审变得高效而富有意义。换句话说:如何让评审人爱上我(被评审人)。
1858 0
如何让评审人爱上我
|
新零售 测试技术
产品经理上线自查清单
上篇文章主要说了需求评审会,需求评审会通过后就是按照排期,依次进行设计、开发、测试、上线,但在上线之前我们通常还要做一件事情,就是上线前自查清单,这事情做好了同样提升威信,做不好就会失去团队对你的信任。
1509 0
|
开发框架 .NET 定位技术