海的女儿 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
[quote]Originally posted by [i]luckyfish[/i] at 2004-11-15 11:34 AM:
最近公司要把文档管理提到议程上来，现在想找一个好的文档管理工具，除了vss外，有没有其他好的，推荐一下，谢谢！ [/quote]
制度
tempuser 2004-11-18 15:12
应该先写文档再开发，然后再补充修正文档
jacobs 2005-10-24 14:25
[quote]Originally posted by [i]luckyfish[/i] at 2004-11-15 11:34:
最近公司要把文档管理提到议程上来，现在想找一个好的文档管理工具，除了vss外，有没有其他好的，推荐一下，谢谢！ [/quote]
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
有知识管理，协作和文档管理功能。
[url]http://www.czsm.com.cn/product/confluence.htm[/url]
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
[color=Green]xiexie![/color]
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.的确很多人都不会写文档，但是也没有人来教开发人员怎么写文档，很多开发人员是想写好文档的，只是不知道该怎么写，久而久之，也就不愿意写文档
总之啦，我感觉是大环境的原因，也许等软件从业人员的整体素质都上来之后，这种情况就会改变吧