您的位置：程序门 -> 软件工程/管理 -> 质量管理/软件测试

我该如何说服公司加强文档工作呢？

[收藏此页] [打印本页]选择字色：背景色：字体：[大][中][小]

我该如何说服公司加强文档工作呢？[已结贴,结贴人:bobor8]

发表于：2007-01-30 22:33:29 楼主

新跳槽到一个小公司搞嵌入式系统架构，发现这个创业五六年，研发十几人的小公司无任何软件文档，开发过程基本处于无管理状态，全靠各程序员自由发挥。我向老总建议每个应用软件（一般一人负责一个应用）都要有《功能定义书》（相当于需求分析）和《设计说明书》（相当于概要设计和），但从老总到经理无一赞同，如何说服他们呢？

发表于：2007-01-30 23:31:441楼得分:10

看情况而定，文档写出来还要维护，这都是要成本的。
如果复杂度不够大，交流充分，只要有好的代码注释，不要文档也罢。
只是作为前几的交流时，可能会产生一些文档。

我们公司有很充分的文档，也只是前期创建，后来维护的就少了。
基本一个人的80%的精力要再投入。
你觉得你们的老板会接受么？

发表于：2007-01-31 10:53:102楼得分:5

樓上的正解,想要老板接受就讓老板看到利潤........

发表于：2007-01-31 16:29:343楼得分:3

很难,公司副总说，要是技术都会写文档就不用做程序员了

发表于：2007-02-01 10:50:474楼得分:2

这种小作坊……

发表于：2007-02-01 11:01:315楼得分:2

基本上很难.....小作坊做小项目....小项目写啥破文档....增加工作时间....当然如果项目大当我没说...

发表于：2007-02-01 11:06:136楼得分:2

并不是做什么都需要文档的。

发表于：2007-02-01 11:17:377楼得分:2

我也在一个小作坊
就我一个人..

发表于：2007-02-01 11:29:498楼得分:2

多从工作效率上提出建议吧，小作坊也是要做文档，前期的文档明确功能模块，明确分配的任务和接口，确实可以提高效率的，后来不维护也行

发表于：2007-02-01 11:46:449楼得分:10

不写文档怎么行，我开发的项目也只有我一个人，我同样很重视文档。如果没有文档，那么自己做的东西都不一定搞得清，我这个项目开发的都快两年了，有效代码行5万多行。其中技术研究性的内容很多。细节不可能都记得住，如果有问题了，最先看得应该是技术研究报告，如果这这个都没有，看代码，要看死人的。所以我写的文档，主要有

项目计划
技术研究报告
每周项目进度报告
版本说明
用户手册
支持的硬件说明（该系统与硬件相关）

近期还准备写一个编译说明

这里面没有常规的需求，设计等说明书，是因为这个项目这些方面目前都很明确。

发表于：2007-02-01 12:01:1510楼得分:3

没有办法。如同华为公司，如果没有任正非认为需要上管理系统，华为的管理就肯定没有现在这么好。领导人员的管理意识是相当重要的。

发表于：2007-02-01 12:09:4811楼得分:0

该回复于2007-12-28 18:13:57被管理员或版主删除

发表于：2007-02-01 12:27:5112楼得分:2

需要文档的，但写的详细与否，就看实际情况了。

发表于：2007-02-01 12:57:4713楼得分:2

文档工作做好了，人的可替代性就增强了。老板看谁不顺眼就可以炒谁，肯定会有很多人反对你。
友情提醒，好好自为之吧。

发表于：2007-02-01 13:08:1514楼得分:1

poney（小马)正解!

发表于：2007-02-01 13:53:5115楼得分:3

老板关心的是会增加多少成本，到底对工作有什么帮助。

两招：
1）在自己的工作中证明一下文档的价值。
2）文档到底写成什么样子才行。比如设计说明是否可以用更好的注视和代码规范代替。javadoc就是基于这种思想。

发表于：2007-02-01 14:32:3616楼得分:1

事实证明,文档的两面性是相当严重的

反对写文档的至少和赞成的一样多

发表于：2007-02-01 14:33:2017楼得分:2

就跟你们老总说不写文档会怎么怎么着，写了文档会怎么怎么着
对比一下

发表于：2007-02-01 17:39:5818楼得分:2

过来学习一下。知道了不少！

发表于：2007-02-01 18:22:0219楼得分:3

人家老总都不同意，你烦那么多神干什么呢，
学点东西，有机会就跳。

发表于：2007-02-01 21:03:5520楼得分:3

这不是写不写文档的问题，而是要改变改变十几个人五六年的习惯的问题！

你觉得这可能吗？

发表于：2007-02-01 21:52:3121楼得分:3

从不写文档也能混5、6年？老板的能力真是强啊~
只能佩服这十几个人的理解跟同步率高的出奇啊~

发表于：2007-02-02 00:05:5822楼得分:3

看来我们觉得你们说得很有道理,要学会做文档的习惯

发表于：2007-02-02 08:03:4323楼得分:3

文档的习惯

发表于：2007-02-02 08:56:2824楼得分:0

我是楼主，来公司才一个月，不过听老板和员工说以前项目开发过程中总会不断变更需求，大多数项目都不能按时release，好在公司是自产自销，没辙！我要大家写文档的目的就是想加强沟通和约束，大家集思广益在前期确定好需求和设计，后期尽量少做更改，保证产品按时上市。但老板说需求变更是不可避免的，还说不可控因素太多，计划制订了也是不能顺利执行的（公司没有任何激励和绩效考核)，真是欲哭无泪啊，不知道他们懂不懂总结提高，有点后悔跳槽来这了。

我们这个项目预计持续时间8个月，代码量超10万行，还有集成的第三方技术，总代码量可能近100万行。

发表于：2007-02-02 08:58:1125楼得分:0

看来是很难说服老板做不能马上见效益的工作。

发表于：2007-02-02 15:39:5626楼得分:4

关键文档还是要有的,比如说数据库部分文档.比较关键的.
需求文档到少也应该有一个总的.功能点的文档最好是要全一点.
设计文档,如果没有特殊的设计,可以少点.
其它的文档,没有也罢.

发表于：2007-02-26 10:40:4227楼得分:4

还是根据实际情况而定吧,

"1.我要大家写文档的目的就是想加强沟通和约束，大家集思广益在前期确定好需求和设计，后期尽量少做更改，保证产品按时上市。
2.但老板说需求变更是不可避免的，还说不可控因素太多，计划制订了也是不能顺利执行的 "

--典型的无法避免的问题

发表于：2007-02-26 14:38:4628楼得分:6

问老板一个问题：

关键程序员a现在的工资是5000元，如果他跳槽，由于没有文档，给公司带来的直接损失将是10万元（假设a做了5个程序，新程序员接手看懂一个程序的代码要4个月，新程序员的工资也是5000），间接损失难以数计。如果a明年提出工资要涨到10000元，否则走人，老板准备如何应对

如果给a涨工资，程序员b的工资涨不涨，还有程序员c也在等着........

然后给老板总结一个道理：代码是员工自己的价值，文档才是真正公司的价值。

发表于：2007-03-14 23:31:5529楼得分:4

最切实可行的办法是你必须从这么多项目中抓出一个反面教程来说服老板。试想，你是干什么吃的？！如果揪不出一个这样的项目来，我看你这小子也该反省一下，你老板不行？你的同事不行？你不行？

发表于：2007-03-15 14:13:2430楼得分:3

先生存再发展。唯一的说法就是交接风险分析。

发表于：2007-03-23 10:12:1331楼得分:4

先吃饱了，再解决吃好。不要谋求一步到位，可以小步快跑！别说小公司了，就是大公司里文档管理也不是很规范和容易的。

发表于：2007-03-23 16:22:3832楼得分:2

xb_feng（)
正解

发表于：2007-03-23 16:24:3633楼得分:4

跟你老总说,五年后垃圾代码十万行..叫个十年经验,博士级的人也要花三个月最少才能维护..
到时你有多少钱来请这些人维护..想想

发表于：2007-03-27 06:55:5034楼得分:0

to:zijcai（)

简单，重写一遍就可以了。

to:xb_feng（)

> > 由于没有文档，给公司带来的直接损失将是10万元（假设a做了5个程序，
程序都写完了，损失会有那么大吗？

新的程序员的工资不可能比老的高，更不会给4个月的时间来学习原来的程序。

另外楼主的公司比较特殊，已经这么运作5、6年了呀，没有什么问题，除了延迟之外。

那么为什么要冒险使用新的方法呢？

发表于：2007-06-06 15:30:1035楼得分:0

主要是让leader体会到用文档的方便

其他资讯