• 软件测试技术
  • 软件测试博客
  • 软件测试视频
  • 开源软件测试技术
  • 软件测试论坛
  • 软件测试沙龙
  • 软件测试资料下载
  • 软件测试杂志
  • 软件测试人才招聘
    暂时没有公告

字号: | 推荐给好友 上一篇 | 下一篇

想编写出优秀技术文档,先学学这四招

发布: 2009-6-10 11:25 | 作者: 不详 | 来源: 测试时代采编 | 查看: 38次 | 进入软件测试论坛讨论

领测软件测试网

让技术文档编写者参与到技术要求、功能规范以及设计方案的开发工作中去。

  把技术文档编写者包括进开发小组的邮件列表中去。

  这技术文档编写的周期,把产品在公司内部进行发布。技术文档编写者很容易变得非常封闭,但是如果把产品在内部首先发布一下,那么就能够给开发人员以及项目管理人员提供一种新的途径来了解以前可能并不容易了解的情况。

  鼓励技术文档编写者更多的了解有关产品背后所包含的各种技术。举个例子来说,如果你开发基于Java语言的应用软件,那么,就应该鼓励技术文档编写者多多了解Java编程语言,并且尽量让他们能够流畅的掌握这门编程语言。

  技巧四:设置任务的优先次序

  通常的情况下,主要的开发设计人员脑海中包含着有关整个项目的信息,而且,有时候还会同时考虑许多其它的项目。即使他或者她的日程安排已经非常的紧张,但是,他们脑海中的产品信息对于确保技术文档编写的准确性来说是非常重要的。

  当前的形势让我们不得不以更少的资源完成更多的任务,而作为开发设计人员,由于他们工作的特殊性,这些人总是处于紧张而繁忙的状态下。下面是一些技巧,可以帮助你从这些忙碌的开发设计人员哪里获得你所需要的信息,并且保证能让他们的知识给技术文档的编写带来好处:

  不要让他们从头至尾的审阅技术文档。
 
  和技术文档的编写者一起确定哪些部分必须让开发设计人员进行审阅。

  与他们一起利用大段的完整时间来审阅技术文档。

  如果技术文档的审阅者时间表安排得很紧,那么就给他提供一个具体的列表,在其中明确哪些部分你需要他进行审阅的。并且保证让小组内的其他成员完成剩余部分的审阅工作。技术文档中与审阅者专业技术领域直接相关的部分绝对是需要他进行仔细审阅的。

  更好的完成审阅工作

  充分有效的完成技术文档的审阅工作不仅会让外部的用户,也会让内部的用户从中受益。但是,经常会有技术人员认为做这样的工作是没有多大意义的,那么,作为管理者就面对着这样一种挑战,就是要在整个的审阅过程中设置好优先次序从而保证为开发工作所做出的努力获得成功。

延伸阅读

文章来源于领测软件测试网 https://www.ltesting.net/

22/2<12

关于领测软件测试网 | 领测软件测试网合作伙伴 | 广告服务 | 投稿指南 | 联系我们 | 网站地图 | 友情链接
版权所有(C) 2003-2010 TestAge(领测软件测试网)|领测国际科技(北京)有限公司|软件测试工程师培训网 All Rights Reserved
北京市海淀区中关村南大街9号北京理工科技大厦1402室 京ICP备10010545号-5
技术支持和业务联系:info@testage.com.cn 电话:010-51297073

软件测试 | 领测国际ISTQBISTQB官网TMMiTMMi认证国际软件测试工程师认证领测软件测试网