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

1、预期读者

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

2、IPO图

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

3、接口

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

4、安装过程

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

总结:

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

[总结]软工文档验收相关推荐

  1. 软工文档总结篇(一)

    1.软件文档的重要性 根据软件工程学的基本原理,强调了软件=程序+文档的思想,软件文档是规范化软件生产的重要依据,他直接关系到软件开发过程的可见性和可控性,因此,软件文档编写在软件开发中具有重要的地位 ...

  2. 软工文档”注意注意“事项

    经过36天的努力,我的软工视频还有软工文档终于完成了,接下来总结一下我觉得需要注意的事情. 首先看视频,我们可以开启 加速,自己一边看一边做笔记,这样可以锻炼我们的打字速度,这个没说什么说的,就是大家 ...

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

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

  4. 机房收费系统个人重构版:软工文档中那些图

    [前言]    图,提到这个字的时候脑海中就会出现许许多多的图像,它的重要性相信大家都明白,相比于文字来说它更生动形象正好符合人类大脑的记忆规律:很多人也知道动画片制作原理也是用一张张图片只不过转换的 ...

  5. 【软工】软工文档——可行性研究报告

    可行性研究报告算是系统开发的一个起点,可行性研究报告是在软件定义阶段编写的一个报告,也是自己着手去写的第一份文档.从中再一次体会到了编写文档的严谨性,对软工思想概念的认识. 可行性研究报告 1引言 1 ...

  6. 软工文档-软件需求说明书

    1引言...2 1.1编写目的...2 1.2背景...2 1.3定义...2 1.4参考资料...2 2任务概述..2 2.1目标...2 2.2用户的特点...3 2.3假定和约束...3 3需求 ...

  7. 【软工文档】机房收费系统之软件需求说明书

    1引言...2 1.1编写目的...2 1.2背景...2 1.3定义...3 1.3.1 专门术语的定义:...3 1.3.2 相关技术与开发工具介绍:...3 1.4参考资料...3 2任务概述. ...

  8. 【软工文档】机房收费系统之详细设计说明书

    1引言...2 1.1编写目的...2 1.2背景...2 1.3定义...2 1.4参考资料...2 2程序系统的结构...2 3程序1(标识符)设计说明...2 3.1程序描述...3 3.2功能 ...

  9. 机房收费系统个人重构版:透过文档谈文档驱动开发

    [背景] 机房收费系统个人重构已接近尾声,在最后阶段自己去补文档以及其中涉及到的图!经过将近一周的奋战将其完善,并最终通过师父的验收.透过这次机房重构写文档和画图,自己感触颇深,在此与大家共享. [文 ...

最新文章

  1. Python 使用 Flask框架记录
  2. base64 数据处理
  3. 如何使git接受自签名证书?
  4. Android开发工具之Android Studio----版本控制SVN使用(一)
  5. 以太坊搭建联盟链详细教程
  6. .NET 状态机Automatonymous快速入门
  7. KVM中断虚拟化(二)
  8. websocket握手失败_WebSocket握手期间出错:意外的响应代码:500
  9. Java程序员必备的11大Intellij插件
  10. ansible安装包和管理 playbook相关
  11. 电脑更新重启后黑屏_电脑黑屏重启还是黑屏的解决方法教程
  12. python编写2的n次方_2的n次方(python计算2的n次方的算法)
  13. vue3 路由跳转,打开新页面
  14. Linux构建一个deb软件安装包
  15. 生活在深圳我们需要的不是叹息与感概
  16. 业内首家全线上碎股自助交易 富途证券:股数有多少,需求无大小
  17. 离职原因该怎么说才比较好 ?
  18. Codeforces Round #657 (Div. 2)B. Dubious Cyrpto
  19. AUTOCAD——偏移命令、移动命令
  20. 刨根问底Objective-C Runtime(1)- Self Super

热门文章

  1. 实现机器人自主定位导航必解决的三大问题
  2. 【信息系统项目管理师】第七章 成本管理思维导图
  3. 什么是Vue组件?如何创建和使用组件?
  4. 蓝桥杯算法:斐波那契求Fn除以10007的余数
  5. poj 2771 有点难度最大独立集
  6. 机器人运动学标定学习笔记
  7. [生存志] 第76节 孔子读易大哉乾元
  8. 用代谢组学解密纳米颗粒缓解烟草重金属中毒机制
  9. PINDEL检测结构变异
  10. 新版仿我爱广告任务网系统源码+Thinkphp内核