51Testing软件测试论坛

标题: 文档的作用和分类 [打印本页]

作者: 海的女儿 时间: 2004-9-2 15:05
标题: 文档的作用和分类
QA都不希望自己像文档管理员般的工作，但是换个角度想想，一个不规范的软件企业，QA的领导能力再强又有何用，对于这个“不规范”的一个明显例子就是文档上的欠缺。在没有人做，实在看不下去，并且你还愿意在公司继续待下去的情况下，还是把这一块抓起来吧！

作者: wangnan 时间: 2004-9-2 15:41
是啊！好多的软件开发人员都不愿意写文档，
认为那是在浪费时间
有几次我和他们沟通，问他们为什么不愿意写文档？
他们用很奇怪的眼神望着我说，
我们对文档没兴趣，思想在脑子里，编码才是关键
写文档，写了也不见得真的那样去做，而且改来该去多麻烦
如果你不嫌烦，你帮我们写得了
气的我差点没吐血！
真是，这世道做什么都难！

作者: skinapi 时间: 2004-9-2 19:20
非常感谢海的女儿共享的这篇文档。
关于项目组成员（包括开发人员和测试人员）不喜欢写文档，个人觉得有一下一些原因：
1。人的惰性，需要通过制度和流程来尽量避免。
2。写文档不方便，比如我们公司都是用word来写文档，可不少开发人员都抱怨写起来不方便，特别是写伪码时，编写和修改都不方便。需要考虑如何让写文档更方便、简洁。
3。不知道怎样写才能简单明了，需要对项目成员进行写作方面的培训。
个人观点，欢迎讨论。

作者: 海的女儿 时间: 2004-9-7 08:48
我一向坚持这样的观点：如果说开发人员不屑写文档，但可以为我们打造出精美的软件，我同样很佩服他们，但是，往往拿到测试人员那边的软件连某些正确操作都会报错，叫人实在寒心，不知道他们的精力投入的含金量真的有多少；
对于文档用什么工具来写，目前大多数公司都是用word或excel。当然，如果能用具有针对性的管理工具进行书写及管理会更好，但是好多公司又不太愿意去买或自己去研发这样的工具，所有矛盾总是存在！

作者: smallfish382 时间: 2004-9-8 09:48
大家都说得有理啊。写文档，开发人员都认为那只是应付一下，哪会按照那个去做啊。
　　　真是郁闷啊

作者: yi3310 时间: 2004-9-8 11:09
谢谢你的文档,我下了,打开一看,很有用的.谢谢!

作者: 海的女儿 时间: 2004-9-13 08:52
有效地写文档是目前必须解决的问题之一，但急不来，还需要提高文档模板质量、转变做文档态度等的时间

作者: lookmezh 时间: 2004-10-19 10:07
文档的管理很大一部分是模版的管理.呵呵.

作者: yy903 时间: 2004-10-19 15:07
标题: 多谢！
谢谢！

作者: beiyue 时间: 2004-10-20 13:44
标题: documentation
非常感谢版主的资料,个人认为这个也非常重要,但我目前所在公司也是不写文档,这样出现的问题不是一俩话能说清楚的,连目分析,设计人员都不写,那到了编码\测试人员更糟糕,编码人员每做一点事情都得去问设计人员关于业务流程方面的问题,结果是对是错说不清楚;测试人员可能什么也不清楚

作者: beiyue 时间: 2004-10-20 13:47
标题: documentation
有了问题,至少责任明确,交流方便,工作有头绪,至于文档质量的提高可能需要一个过程

作者: rosycloud 时间: 2004-10-25 15:35
QA要能工作好,发挥作用,一个首要的前提就是领导能够重视要软件过程规范和文档完整的重要性,否则QA人员根本没法工作.很多开发人员对QA人员的工作都有抵触情绪,他们根本不愿意把自己的思路用文档的形式表达出来.这点必须要有强制性.

作者: duzhy 时间: 2004-10-31 19:21
文档的完善和管理有很大的关系，人都是有惰性的。没有督促和考核，是没有人喜欢写文档的。

作者: luoyear 时间: 2004-11-1 13:28
如果上下游的接口作用必须靠文档去传递
那么
逼迫写文档的好好去写
读文档的认真去用
所以目前国内文档书写最好的部分肯定是用户手册
最糟糕的部分肯定是设计文档

作者: xiaojinzi 时间: 2004-11-4 11:12
谢谢。

作者: zjm0326 时间: 2004-11-5 17:21
谢谢海的女儿，对我参与评审很有用

作者: luckyfish 时间: 2004-11-15 11:34
标题: 有没有什么好的文档管理工具？
最近公司要把文档管理提到议程上来，现在想找一个好的文档管理工具，除了vss外，有没有其他好的，推荐一下，谢谢！

作者: luoyear 时间: 2004-11-17 12:42

Originally posted by luckyfish at 2004-11-15 11:34 AM:
最近公司要把文档管理提到议程上来，现在想找一个好的文档管理工具，除了vss外，有没有其他好的，推荐一下，谢谢！

制度

作者: tempuser 时间: 2004-11-18 15:12
应该先写文档再开发，然后再补充修正文档

作者: jacobs 时间: 2005-10-24 14:25

Originally posted by luckyfish at 2004-11-15 11:34:
最近公司要把文档管理提到议程上来，现在想找一个好的文档管理工具，除了vss外，有没有其他好的，推荐一下，谢谢！

CVS

作者: jacobs 时间: 2005-10-24 14:30
大家觉得文档模板的管理如果按照测试周期的不同阶段来管理怎样？

作者: 韩冰冰 时间: 2005-12-11 20:19
但是在实际的工作中,很多公司都是项目完毕之后才有相关文档,我也碰到这种情况,头痛!!

作者: Linda_123 时间: 2006-2-14 17:07
写文档的本质是为了交流, 为了将信息准确的记录下来并传达给其他人。开发人员之所以反感文档本人人为原因有以下几点：
1。认为文档写起来太费时间
2。真正需要的文档很容易跟不上更新的节奏，不能真正起到准确交流的作用
3。某些公司的文档过多，过于烦杂，实际的作用不是很大
所以本人认为：如果能够加强交流，撰写必要的文档，减少或者简单化部分文档，对一些公司来说更好。
不要把简单的事情复杂化。

作者: 海的女儿 时间: 2006-2-15 16:22
……
"1。认为文档写起来太费时间
2。真正需要的文档很容易跟不上更新的节奏，不能真正起到准确交流的作用
3。某些公司的文档过多，过于烦杂，实际的作用不是很大"
……
出现这些问题,1、不会写文档，就好象不会写作文一样；2、不会管理文档，所以更新跟不上。3、不会制定流程，所以闲杂文档过多。

作者: Linda_123 时间: 2006-2-22 16:15
海的女儿分析的很正确.
这是很多公司现实中出现的问题. 是个恶性的循环. 不合适的流程导致闲杂文档过多, 而文档管理上的欠缺就不能真正发挥文档的作用. 而不会写文档又使的程序员更加厌烦写文档.
现实中三者的平衡并非容易.........

作者: meirain 时间: 2006-3-9 22:30
标题: 推荐你用一个专业的企业级wiki软件：CONFLUENCE
有知识管理，协作和文档管理功能。

http://www.czsm.com.cn/product/confluence.htm

作者: peiyan419 时间: 2006-3-15 11:02
看了各位上面的讨论，真是受益不浅．我刚入ＩＴ这个行业不到一个月，应聘的职位是文档工程师，其实我对这方面的知识知道的甚少，就全当一个跳板一个学习的机会．现在公司的情况很不规范，刚从母公司分出来的，呵呵，上司又是一个很＂搞乐＂的人，他没有明确安排我的工作，现在项目组在外地封闭开发，看着大家都很忙，我却无所事事，根本没有人去写文档，我好不容易弄出来的文档模板也用不上．上级说过些时候带着我做测试，这样的上级，不知是幸运还是不幸，什么都自己摸着走，没人告诉我要做什么，应该做什么！

作者: rrazz 时间: 2006-3-15 11:23
文档的重要性很多的开发工程师未必能意识到，我的个人建议:
1.如果整个公司在制度上就做了硬性规定,强调了不写文档的风险,慢慢大家都会养成习惯,这一点是不管用CVS还是VSS都没发比的.
2.设计文档格式的时候,例如在EXCEL里只需简单的调用宏,就可以实现一些小功能,这样也会方便大家的书写.
3.设计文档或者处理文档给大家的印象好像都是打杂的干,这都是IT业界存在的误区,文档书写都是基本,一切都是要从细节基本做起

作者: peiyan419 时间: 2006-3-15 11:47
呵呵，我现在就觉得自己是打杂的．
上级一点也不与我沟通，我也不知道怎么下手去开展工作，这样无所事事也不是办法．

作者: Ereese 时间: 2006-6-25 12:09
xiexie!

作者: yangxiaowen0622 时间: 2006-6-26 18:24
标题: 写文档是要了开发人员的命
写文档是要了开发人员的命。这是我在工作时候的总结。每次到催文档的时候。象讨债似的。总结下来。要有好的文档。领导的支持是关键。模板的简洁是基础。希望自己不要再当债主了

作者: firemonth 时间: 2006-7-25 00:36
了解目的，具体问题具体分析，文档因公司而异。

作者: 丰先生 时间: 2006-7-25 10:31
对于QA人员来说，要保证公司能产出高质量的文档（包括开发、测试文档）的确不是件容易的事。需求有步骤地要求、持之以恒地监督，逐步提高文档质量。当然过程中还要提供必要的帮助，比如有文档模板等。

1、宣导文档重要性的理念，辅以公司的强制推行措施。

2、理解他们转变时的痛苦，为他们争取写文档的时间，为他们提供文档模板。最重要
的是开始不要要求太高，能依葫芦画瓢，有文档产生，这一阶段的任务就算完成了。

3、等多数人都有了写文档的概念后，就要开始不知不觉要求文档的质量了。可以通过
检视、评审提出这种要求，这一步的文档质量就必须是言之有物，并且比较规范。

4、最后一步就是要求文档完全规范，文档书写认真、严谨，不能有错别字之类的“细节问题”
，可以从文档产生的流程上强制规范，比如文档产生后，必须通过哪些检视，甚至可以与
KPI挂钩等。sdlkfj5

[[i] 本帖最后由丰先生于 2006-7-25 10:36 编辑 [/i]]

作者: mengxb001 时间: 2006-7-25 11:38
看来我目前公司还是比较幸运的了

作者: ldneliza 时间: 2006-7-28 11:22
没写过，学习先。

作者: ClarkZhao 时间: 2006-8-1 17:04
拜读ing!

作者: kathine 时间: 2006-8-3 11:31
我现在的处境和peiyun419一样，很茫然，希望高手指点。

作者: cindyhuipeng 时间: 2006-12-14 15:10
与开发人员沟通还是挺困难的，大家只能尽量的相互理解了

作者: byonie 时间: 2007-4-11 11:19
我认为文档其实是开发中很重要的一部分，可是开发人员却很不重视。现在急需提高他们的意识。

作者: langchu 时间: 2007-4-11 13:59
我是搞开发的，文档的事情我是这么感觉的
1.很多公司的项目本身就决定了是在赶项目，开发都不一定时间够，更何况写文档的时间
2.很多公司在制度上对文档根本就没有保证，靠个人来推行文档肯定是很困难的
3.的确很多人都不会写文档，但是也没有人来教开发人员怎么写文档，很多开发人员是想写好文档的，只是不知道该怎么写，久而久之，也就不愿意写文档

总之啦，我感觉是大环境的原因，也许等软件从业人员的整体素质都上来之后，这种情况就会改变吧

作者: kuaiking 时间: 2007-4-11 14:18
不愿意写文档的开发人员注定只能当一辈子code worker了..

作者: langchu 时间: 2007-4-11 14:23
这也就是为什么人员结构总是金字塔形的原因了，哈哈

作者: muzi 时间: 2007-4-25 10:27
综合指数为零,下不了!~
强烈抗议管理员的这种行为.人家发资料来给大家用的,管理员反而限制不让我们新手用.
抗议!~抗议~!

作者: 冬听雪 时间: 2007-4-25 13:52
标题: 文档确实很重要
现在刚开始做QA的工作，还在不断学习中，但是觉得文档不管是对测试还是对整个项目的质量控制都起着至关重要的作用。

作者: winter0220 时间: 2007-4-27 11:39
我觉得在对日软件公司这块还是做的挺好的，因为不得不承认日本人他们的软件开发思想和过程控制比我们高很多，对文档他们的要求是很严格的，所以中方公司在被强制写一些文档后，公司里的领导和员工也都慢慢有了写文档的意识。
所以说写文档，我觉得还是要有一个强制的过程，慢慢大家发现这样做的好处了就会自觉去做了！

作者: weimj2008 时间: 2007-4-29 14:18

原帖由 langchu 于 2007-4-11 13:59 发表
我是搞开发的，文档的事情我是这么感觉的
1.很多公司的项目本身就决定了是在赶项目，开发都不一定时间够，更何况写文档的时间
2.很多公司在制度上对文档根本就没有保证，靠个人来推行文档肯定是很困难的
3.的 ...

非常典型的说法。
我从事软件开发12年，连详细设计文档都完全做好，我负责的项目就会延期？
很多人认为写文档浪费时间，这个想法与“读大一不如直接读大四”的想法基本一致。

作者: crystalpear 时间: 2007-5-9 18:14
总觉得开发人员无法理解测试人员的辛苦

作者: h220000 时间: 2007-5-14 14:42
标题: 回复 #29 peiyan419 的帖子
我的上级也是这样,刚开始很郁闷,后来自己在工作中找到一些问题点,主动跟老板沟通交流,几次下来,现在也开始重视文档这一块了

[ 本帖最后由 h220000 于 2007-5-14 15:09 编辑 ]

作者: zgslhyh 时间: 2007-5-14 15:22
没权限下，，，

作者: lixllizi 时间: 2007-5-14 22:26
我们公司这点做得还不错

作者: kilen_he 时间: 2007-5-15 17:27
同一楼上的观点

作者: swallowlly 时间: 2007-5-15 18:46
以前做过开发，也写过文档，如果从流程上强调文档的重要性，大部分开发人员都不会正真的写好。
提高项目质量，流程是一方面，最重要的还是提高项目开发人员的能力

作者: zuojingqin 时间: 2007-5-16 09:10
标题: 回复 #22 韩冰冰的帖子
是的,我现在才觉得一个公司的流程化管理真的好难,有些领导认识是必须做的,可是,有些领导觉得多一个测试人员没什么必要,而且,还认为有了测试人员就必须包证没有BUG出现?你们认为这合理吗????

作者: 高跟鞋跳舞 时间: 2007-5-26 14:21
没有文档,需求变了,测试人员都不知道.

作者: 春雨蒙蒙的下 时间: 2007-6-1 16:29
我也曾经做个开发，个人觉得文档十分必要。
（1）对自己后期修改工作很重要，好记性不如烂笔头，这句话没错；
（2）与项目实施人员工作交接的重要内容；很多时候，开发人员在项目交接时不提供这些文档，项目实施人员实施中遇到问题，直接向开发人员咨询，这时又浪费开发人员的时间，又耽误实施进度，其实只要文档维护好，实施人员实施前认真学习就可以避免；
（3）对接手工作的人有益处，开发设计时的详细设计文档或概要设计文档对接手维护工作的其他人无疑是救命的，如果没有这些，他即使阅读代码能力超强也很难掌握你的思路和方法。

作者: linglingqiu 时间: 2007-6-3 04:13
谢谢海的女儿

作者: china110 时间: 2007-6-4 11:39
三大

作者: snowyer2004 时间: 2007-6-4 16:38
我怎么下载不了了
晕

作者: yiding_he 时间: 2007-6-4 17:54
我是一名开发人员。我是这样看的：
1、文档的作用，不可否认。项目是大家一起做的，所以沟通少不了。文档的目的就是沟通和记载。“源代码是最好的设计文档”的说法虽有争议，但该说法也仅限于设计文档。总之项目当中文档是必不可少的。

2、文档的形式，是否一定要用 Word 文档（或者 wps、odf 等），其他形式（网页、Excel、数据库等）是否可以？通常人们都认为文档应当以描述性的文字为主，结构化的数据人们都不看作是文档。这样的态度我认为不正确。如果这些内容就是用于项目的沟通和记载的，那么都应看作文档。

3、文档的编写，是否一定要手工编写？很多报表其实都是“数据+模板”生成的，某些文档是否可以参考这种方式？如果我可以查到指定开发人员这个星期修复的 BUG 列表，那么我还需要让每个开发人员写文档告诉我这个星期修复了那些 BUG 吗？如果我可以用工具生成 UML，我还需要在 Word 里面一个一个方框的画吗？

写文档又不用怎么动脑子，如果每天只要做八小时，我都恨不得把文档写成水浒传，程序？慢慢来。但是如果今天非要把这个功能完成不可，我可不想加班。代码能省吗？省不得。那怎么办？只好在文档上偷点懒咯。

作者: Jennyezkj 时间: 2007-6-5 10:19
谢谢分享！我也觉得一个测试项目的文档管理环节很重要。不但有条理，比较规范还起到总结的作用。

作者: deter 时间: 2007-7-2 11:45
文档很重要，但过多的文档会招来开发人员强烈的抵制，如何裁剪文档是QA的工作之一

作者: Croshere 时间: 2007-7-11 16:15
文档编写确实。。很难说白

作者: letfoxrush 时间: 2007-7-20 17:02
总结得好。
只要真真正正经历过写文档的开发过程，都会觉得开发中想要获取到更好的质量和更好的管理，文档是必不可少的。

作者: ft3312 时间: 2007-7-23 19:49
标题: 回复 #1 海的女儿的帖子
佩服

作者: pbtlight 时间: 2007-7-27 09:02
现在公司并不认为文档是个产品，认为最终可以执行的软件才是产品，而且在安排计划的时候并不给写文档安排时间，还有就是楼上说的很多人确实不知道如何写文档

作者: cleo 时间: 2007-8-1 10:21
学习中，帮楼主顶一下

作者: changlang530 时间: 2007-9-3 11:36
大家好像都比较说软件开发人员的短处，这是国内很多小企业的习惯影响这些新生代

作者: 我爱大熊 时间: 2007-9-12 14:51
sdlkfj6

作者: judyni 时间: 2007-9-13 09:43
thanks LZ

作者: qiufeng 时间: 2007-9-19 17:27
想下载看看
！

作者: red-hat 时间: 2007-9-19 20:44
楼主是身做什么的啊!

作者: 欧洲 时间: 2007-10-9 21:11
一直为自己处在没有正规测试流程公司里而懊恼，受着，上（最高领导）：要文档，中（直管项目经理）：不与你沟通、不告知需求的气。看了以上的贴后才知道原来大家都有类似经历。
看来要在版里好学习。

作者: jenny0842 时间: 2007-10-10 11:48
综合技术指数是什么东东

不给我下载。晕

作者: yuanyan_13 时间: 2007-12-27 22:40
多谢，好东西啊

作者: today603 时间: 2007-12-28 16:08
我也有类似的经历，开发人员都忙的不可开交，收集成果一遍一遍的催，没办法...

作者: laipi 时间: 2007-12-29 09:21
学习中受益匪浅啊

作者: zhang88614 时间: 2007-12-29 09:42
标题: 回复 1# 的帖子
现在一般都是以应付为主，怎么样使得他们变成一种自然的工作，扭转这种思想很重要。规范需要去做，更做的是做一些其他的工作来说服他们。

欢迎光临 51Testing软件测试论坛 (http://bbs.51testing.com/)