软工文档验收,师傅对我的文档提出了很多需要注意的地方,这里与大家分享一下!
1、预期读者
在软件工程文档的编辑过程中,每篇开始都要介绍这篇文档的预期读者和编写目的,掌握了每个文档的使用者,我们才能用合适的语言来向不同的人群介绍我们的软件。如果我们一直向将要使用这款软件的老师(一点不懂软件设计)介绍代码的知识,恐怕会适得其反。2、IPO图
在介绍软件功能时用到了IPO图,参考了一些文档终于找到了一张像样的图这个链接里面还有很多图的说明,供大家借鉴:
3、接口
师傅向我提出了这两个问题:接口是如何设计的?你对接口的理解? 我对接口只有一个广义的理解:不同的语言有不同的接口,接口要简单,方便以后修改。接口用于不同的层之间联系,就像我们用代码去调用数据库中的数据,要用什么样的函数,什么样的方法,怎么声明。。。所以,不同的语言有不同的接口。 为大家推荐以下的链接: 软件接口设计指南 软件接口设计 抽象类和接口的区别4、安装过程
操作手册和用户手册都是写给用户的,我们可以添加一些安装手册到文档中,为用户安装提供便利,以下是安装步骤,大家在平时安装软件的时候都很熟悉了 通常电脑在安装上stall文件时也会安装上自己的移除文件。分为六步:
①欢迎使用该软件的讯息提示
②阅读终端使用者授权条款(EULA)
③选择要安装的组件
④选择要安装路径
⑤确认配置信息并准备开始安装
⑥提示安装完成。
总结:
软工文档是我们自己写的第一个文档,在最开始接触文档时候要明确每个文档的写作目的,面向的读者,除了安装模板的要求,也要有自己的想法,站在用户的角度,用合适的文字来描述。<如有不妥,欢迎指正>