欢迎光临南京典乐信息科技有限公司
24小时:400-025-1949
繁體版
手机版
知识中心
检察院网站也需要专业网站制作人员
当前位置:首页 » 知识中心 » 知识中心

如何写好文档

发表日期:2017-09-15 12:16:45文章编辑:浏览次数:643 标签:知识中心    

关于文档,我最近探索如下写法写文档,拿一个相对明确的功能来说(没人要求,我自己摸索的,我们用的是scrum,不怎么要求文档):1需求该部分希望需求人员给予评审,确认,测试人员对该部分理解认可以。1.1用户需求用“作为一个……,我希望…&helli ...

关于文档,我最近探索如下写法写文档,拿一个相对明确的功能来说(没人要求,我自己摸索的,我们用的是scrum,不怎么要求文档):
1 需求
该部分希望需求人员给予评审,确认,测试人员对该部分理解认可以。
1.1 用户需求
用“作为一个……,我希望……,以便于……”句式整理用户需求,重点是“以便于”部分。
这部分应该不会有太多条,多于五条则要反思是否对需求理解有误。
1.2功能需求
以“A应该……”句式整理功能需求。主要就是需求求,需要系统实现哪些功能。
1.3 限制与依赖
列出该需求受哪些限制,依赖于什么。这部分是写给自己和测试人员看的,知道了限制与依赖,不要写出不必要的测试用例。这部分需要得到测试人员的认可与理解。
1.4 假设
要实现功能,有很多假设,一定要罗列出来,并与人交流。此处也需要得到测试人员的认可与理解。

其实这些真正写起来没有多少,我写的时候也没出现没思路或生搬硬套的问题。但是这些是整理需求过程中的工具,及在理解需求后的整理。
最近在看《软件需求 第三版》,此部分是对该书内容的应用与演练。

在整理完需求后,我一般会画一个关联图,确认一下需求的边界与交互对象及主要交互。

2 针对需求的测试用例
针对上面需求而整理的测试用例,此处需测试人员的参与与评审。有了前面的需求,此处写起来很快,也不会有太多的测试用例。
3设计
大体描述一下设计,我很多时候主要用来整理思路。
4 针对设计的测试用例
这一块针对设计写一些测试用例,要覆盖针对需求的测试用例。这一块测试用例主要自己用,在编码完成后知道怎么验证。
5时序图
编码完成后,画一下时序图,以便别人了解自己代码的调用流程。如果是OO代码,我打算在此处放置一下类图,并添加一个类作用的表格。

专业服务:南京建站,南京网站制作,南京网站设计,南京网站制作公司

咨询电话:13851941123(7*24小时在线服务)

咨询QQ:260193150

公司网址:www.icanpk.com

本文地址:http://www.025app.com/knowledge/detail_54.html

相关新闻

JS,JQuery的看法

在我看来对于前端来看,JS是语言,JQuery好比一个封装的…

日期:2017-09-16 浏览次数:422

即时通信服务器架构的个人看法

1routeinfoserver可以进一步抽象成元数据服务器…

日期:2017-09-16 浏览次数:453

究竟传统的SOA架构中的什么缺陷、不足,被微服务很好地解决了?

记得之前在某三甲医院参加过一个交流会,某ESB厂商举办的,当…

日期:2017-09-16 浏览次数:320

个人看待微服务

我觉得微服务的各个独立应用的功能、职责划分很含糊。比如,要是…

日期:2017-09-16 浏览次数:343

如何做好UT的几点

1:很多公司或领导在做UT的时候,会要求代码全覆盖,其实这是…

日期:2017-09-15 浏览次数:794

关于我们
技术支持
联系我们
南京典乐科技
客服电话:400-025-1949 (工作日9:00~18:00)
项目经理:138-519-41123
咨询 Q Q:260193150
公司地址:南京中华路420号江苏省科技中心5层
客服QQ
获取报价
联系电话
400-025-1949
返回顶部