• 8
  • 5
分享
  • 继承者——功能说明文档
  • lee 2022-06-23 11:51:51 字数 670 阅读 7434 收藏 5

敏捷开发迭代速度快?开发完上线之后找不到相应人员?下一轮优化时不知从何下手?

相信大家在平时的工作中都遇到过相关的问题,究其原因是没有留足够的时间进行相关文档的沉淀和归档,导致后来人员对于之前的项目不够熟悉,不知道如何下手。所谓好记性不如烂笔头,结束一个项目时抽空整理出相关的特点,给后来人一个大概的论述,相信能很好的发挥承上启下的作用。很感谢我的上一任上司,她督促我们每一个版本都需要养成总结文档的习惯,写功能说明文档的习惯也是从这个时候慢慢继承下来的。

这里说的继承者是指——功能说明文档。每个专项开展测试,有新功能的时候都会测的热火朝天,但是测试结束之后,这个功能交接给另外的同学时或者合并到系统项目上时,又会出现功能继承缺失的情况,所以写好功能说明文档很重要。

功能说明文档包括以下几个方面:

  1. 功能使用截图;

  2. 功能实现原理;

  3. 涉及到的数据库和表;

  4. 遗留的缺陷。

【功能使用截图】

这个章节包括该功能的使用说明和使用方法,需要附上截图,防止出现不会使用的情况。对于按钮比较多的地方最好指出按钮对应的下一步功能。

【功能实现原理】

该功能的概要设计是什么样子的,需要附上概要设计接图,方便出现问题时进行定位。定位出是哪个部件导致的问题。

【涉及到的数据库和表】

一些数据入库需要经过哪些表和库,设置哪些接口,都需要标清楚。该版本新增了哪些表,删除了哪些表都需要一一记录。

【遗留的缺陷】

该功能给出结论是“通过”,但还遗留一些不影响上线,需要后期修改的bug,全部归类在这里。方便后续人员追踪。

以上就是我个人认为功能说明文档应该包含的一些部分。希望能对大家有所启发。

微信图片_20210810194606.jpg

  • 【留下美好印记】
    赞赏支持
登录 后发表评论
+ 关注

热门文章

    最新讲堂

      • 推荐阅读
      • 换一换
          • 读者提问:在线二维码生成器有推荐的吗 ?阿常回答:有,草料二维码。官网地址:https://cli.im 阿常碎碎念:平时给小伙伴分享文件、图片、文章、音视频,用草料二维码很方便,推荐大家使用。看完今天的分享对你是不是有所启发呢,有任何想法都欢迎大家后台私信阿常,一起探讨交流。
            0 0 1002
            分享
          •  常见的软件测试用例设计方法,个人认为主要是下面这6种:  1)流程图法(也叫场景法)  2)等价类划分法  3)边界值分析  4)判定表  5)正交法  6)错误推测法  这6种常见方法中,我分别按照定义、应用场景、使用步骤、案例讲解这4个部分进行讲解。  所以本文行文结构如下:  1、每种用例方法定义、应用场景、使用步骤、案例讲解  2、每种用例方法应用场景的区别  3、深入学习资料分享  一、流程图法(也叫场景法)  1、使用场景  所谓流程图法,就是专门针对软件业务流程测试的方法。  2、什么是业务流程?  业务流程,是指客户在使用软件的过程中,为了达成自身的所想要的目的,按照指定的顺...
            0 1 4864
            分享
          •   苹果公司研究员菲尔-席勒(Phil Schiller)警告说,尽管苹果公司试图在监管规则全面生效之前加强安全性,但在欧盟国家为 iPhone 引入第三方应用程序市场可能会给用户带来巨大的隐私和安全问题。  《欧盟数字市场法》(EU Digital Markets Act,DMA)迫使苹果公司在欧盟成员国向第三方数字店面开放iPhone,从2024 年 3 月起,在iOS 17.4更新中,除了苹果公司自己的App Store之外,还将启用侧载和替代商店。  为了准备引入第三方商店,苹果公司已经概述了各种收费方式的变化,以及确保用户安全的安全机制。不过,苹果公司警告说,这并不能防范所有可能发生...
            0 0 924
            分享
          • 1、关系型和非关系型数据库的区别?关系型数据库的优点容易理解,因为它采用了关系模型来组织数据。可以保持数据的一致性。数据更新的开销比较小。支持复杂查询(带 where 子句的查询)非关系型数据库(NOSQL)的优点无需经过 SQL 层的解析,读写效率高。基于键值对,读写性能很高,易于扩展可以支持多种类型数据的存储,如图片,文档等等。扩展(可分为内存性数据库以及文档型数据库,比如 Redis,MongoDB,HBase 等,适合场景:数据量大高可用的日志系统/地理位置存储系统)。2、详细说一下一条 MySQL 语句执行的步骤Server 层按顺序执行 SQL 的步骤为:客户端请求 -> 连...
            0 1 6145
            分享
          • 一、背景。最新一年(2019)的软件测试大赛即将拉开帷幕,今天与往年相比,增加了自主可控的分赛项,进一步的丰富了比赛的内容,各项评分依据也更加明确,因此能够根据分数更有针对性的找出自己的代码问题了,从而获得更好地分数,提高脚本编写能力。评测工具完善速度之快,超出个人想象,可以看得出来主办方费心了,预祝软件测试大赛发展的越来越好。自主可控赛项的比赛内容有三部分构成,分别为:功能测试、性能测试、众包测试,其中功能测试的内容就是利用Selenium测试工具对Web应用进行功能测试。之所以称作为自主可控,是因为待测试Web应用是部署在国产的应用服务器上面的,采用的国产CPU、操作系统等,具备完全自主知...
            12 13 3318
            分享
      • 51testing软件测试圈微信