一次“研发文档管理体系建设”沙龙实录

surfacer · 发表于 2012-4-13 10:24:09

XX月X日，来自XXXXX、XXXX、XXX、XXX、XXXX等公司的相关研发负责人，与XX的资深顾问们共同参加由XX管理咨询有限公司举办的《研发管理》沙龙系列活动。
本次沙龙的主题是：“研发文档管理体系的建设”。
沙龙上的气氛轻松而活跃，与会者纷纷各抒己见。交流了文档建设过程中的问题和困难，分析了困难产生的原因，以及提出了一些有效的解决方法。包括文档体系应该包含哪些内容，如何建立文档体系，以及如何推行和有效的实施文档管理，即如何有效的与绩效考核相结合的问题，与会者分享了各个公司的经验和教训。
XX顾问结合与会者提出的问题，也发表了一些建设性的意见和建议。会议结束后，大家都觉得收获很大。XX组织的这种形式的沙龙给主管研发的经理们提供了一个非常好的交流平台，大家都受益匪浅。

以下为沙龙对话记录：

主持人：
我们这个沙龙不是培训，所以我们随意一些。文档建设这个工作是非常难做的，我以前在XX公司当了三年的项目经理之后，把我调任了一个新的职务，叫文档管理员。于是我的文档工作就管了一年，所以我待会可以跟大家交流一下文档管理的经验和教训。
今天大家发言围绕几个主题，第一就是文档建设过程中遇到过哪些困难。举个例子，比如说文档不齐备，一些文档是错误的，常常跟我们具体内容对不上。以前我跟一些项目经理聊天，这些项目经理就跟我开玩笑说，最好让竞争对手把我们的文档都偷去更好，为什么呢?我们的文档错得一塌糊涂，偷去准把他们搞死。
第二是为什么会出现这种问题，我们要分析为什么会出现这种问题的原因，不知道这个问题发生的原因我们就不能从根上来解决这个问题；
第三，就是怎么解决。每个在座的都可以谈一下经验和教训。
（待续）

xlf63 · 发表于 2012-4-28 16:07:20

好的文档管理，可以将一件事的来龙去脉弄清楚，让后人知道当时是如何考虑的，工作中碰到了哪种阻碍，是如何解决的，给后人以帮助及启发。是个很费时费力的工作。但是很多大佬多不清楚文档人中间的甘苦。再说也比较难以考核。文档搞的粗还是精细，和人员及规则的制度大有关系。

xlf63 · 发表于 2012-4-28 15:51:10

文档管理，可是一门学问。但现在一般的小厂多不注意。
拷贝克隆过来的图不在意。化钱买来的才很小心。
实际文档相当于企业的软实力，和实物仓库有的一拼。
但是有几个老板明白这事？嘴上说要重视，说说吧了，大多只能兼职的。所以。。。哈哈，随着时间的推移，人员的流动，文档成了没用的摆式。

李泽 · 发表于 2012-4-25 08:21:11

呵呵。这个文风很有趣啊

surfacer · 发表于 2012-4-17 08:24:07

看来大家兴趣不大，不更新了

surfacer · 发表于 2012-4-16 12:21:53

熊 X：这个找起来我觉得还是比较快的，每次不会超过一分钟，只要知道内容。关键是你找到他对你有没有用。

张XX：我却觉得找文档是个问题，一个项目完成，你至少要写300个文档。一个公司十年就有上千个Project ，你怎样在上千个Project里，找几年以前的某一张图纸，或某一个具体的文档。

黄XX：全文检索。我们有这个软件，比如你要找建设局会议，打关键字就出来了。这个软件可以检索的文件有两种，一种存在数据库里，一种就是纯文件的光盘检索系统。我们自己都开发出了文档生成工具，更改后只要点一下，一百页，六十页的文档就自动生成出来了。

王 X：那你全文检索肯定会出来很多很多文件，你还得在其中再找，这比较麻烦。

黄XX：那这个就相当于在搜索引擎上搜索东西一样，你可以输入会议日期，如果你自己也参加了，就可以打自己的名字再检索。

王 X：我们公司的文档很齐全，或者说太多了。我们有System Requirment，然后Higtlight Design，Detail Design。还有用户文档。
我们一个系统很多个网员，会写很多文档。我们有一个文件系统叫PDS，可能是国外的，也是检索，但是会有一个文档上载人员。你可以把文档上载上去，由他来决定他的关键字、项目、类别，然后存在数据库里，我们每个人有一个密码，我可以去搜索文档，但问题是，搜索出来的文档很多，要么找不着，找着了也不是我所需的。可能是上载人员对关键字的敏感度不好，另一方面，这个软件可能在逻辑上真的有一定的问题。
我们现在想的弥补办法就是做一个Project这样的网站，每个Project有一个网站，然后按网员来分。每个产品都有一个Excel文件，从里面列出了各类文档在PDS上的number ，这个相对来说就互补了一下，比较好，但就要求项目管理人员比较勤劳。因为公司已经有一个PDS在上载文档了，做不做Project网站仅仅是个人的意愿，根据自己的工作态度来做，但对于我们寻找文档来说就希望能两者相结合。
文档很多，该怎么有效检索的问题。全文检索我觉得还不是很好，我们有一个软件检索的Public Document System，也是从国外引进的，我感觉还是不很理想，我们经常查找不到需要的文档。

黄XX：我们的系统，比如要查江XX同志在xxx会议上的讲话，打入关键字就可以了，关于这次会议的资料内容就全部出来的。

张XX：我觉得文档跟公司的重视程度有很大关系，看让谁去做。比如开发文档要让开发部的主管或Manager参与，去建立体系，不然就会面临很多问题。
必须是一个职位比较高的人员，或者说他本身就做过很多文档，有切身体会，或在检索中就遇到过这类问题。比如我就有这类问题。因为文档最基本要有编号，Version，有历史纪录，命名，怎么保存，这些全都要标准化，但建立这些所花的工作量是很大的。而且你的目的就是检索要快，才能提高你的文档的利用率，对以后的开发缩短时间。
但现在我们的客户按Project，做得很复杂，但他们要找文档很简单。客户是这样做的，像我们做一个Bom，你的产品是分层的，你的物料在Bom里是分Level的，我的客户是这样做的…………他们的编号每个字母都代表一定的含义。他的Bom是个Part，还是其他，在他们的编码里边都可以体现出来。你看索尼爱立信手机上都是KRY开头，装成整机以后就是KRY开头了。包装盒是DPY开始，只要把码输入系统，所有的相关文档资料就出来了。

（待续）

surfacer · 发表于 2012-4-16 12:15:53

张XX：你要基于Web的话，和你的供应商、和你的客户沟通之间不存在问题，假如说你今天在深圳，明天到上海去了，你照样不影响你的工作，只要带个笔记本电脑，上网就行了。不论走到任何地方，你和你的客户用的是同一个平台。

黄XX：我们在文档建设方面也遇到大家所讲的问题。你们可能都是电子类、消费类产品，我们就是纯软件的，所以文档就更重要。
比如项目经理要查一些东西，如果没有文档的话，就非常难维护。跟进过去要花半个月至一个月时间，而且我们的文档最初始的需求是这样的，根据这个需求会派生出一系列的文档来，比如概要设计、分析、详细设计、甚至用户手册这一整套的东西。因为需求是经常变更的，一般来讲，能保证需求方面的文档能达到比较新的程度，比如最近一个月。但是对后续的，比如说分析方面就比较难了。
我们在日常的管理中也想了一些办法，第一就是给这些研发管理人员进行培训，提高对文档的认识，因为大家都觉得我做的就是产品，我把产品做出来给客户了就OK了，文档又不能卖钱，但实际上文档在验收当中是很重要一项。
第二就是像一些内容能快速的对文档进行变化更新的跟进机制，比如我们自己开发的一些文档生成工具。
第三就是刚才大家提到的采用标准的文档格式，这有几个好处，第一写的时候有针对性，比如客户的需求，一般需求是什么，在特殊情况下有什么需求，还有这个分析基本的功能有哪些，特殊的功能有哪些，分条分块，既方便写又方便看，也方便交流。
第四点就是把文档提高到一个配置管理高度来讲，把它跟代码，设计文档都当作配置项，定期的由配置管理员进行一些审核，然后对验收前等重大的也是组织评审。

熊 X：文档最值得借鉴的就是日本的文档。他们交过来的OEM文档真是齐整。老外作文档做得真不错，几乎到了傻子都能看懂的地步。他们的文档从一份文档就可以看出经过了多少次变更，每次变更的内容。

黄XX：我们开头的第一页都是文件变更控制，什么时候由谁变更了哪一部分。但实际上这些都是空的。文件编号到3.0，4.0，我们现在都是1.01、02、03这样编码，然后有重大的变更的话就取2.0，再有大的话就3.0，我们编号的规则可能跟你们不一样，我们是按项目来分的，比如说深圳市建设局……
而像这种游离在正规的编号之外，比如某年某月关于某重大需求的会议的会议记录，这个我们就专门搞一个目录，我们用Vsourcesafe，主要就是当作一个文件服务器。项目文件里包含会议记录、周报、月报等，但技术文档在不在编号里。

熊 X：我们公司和你们公司不一样，我们公司是有一个项目开发手册，其中有一栏里边专门放置会议记录，周报，月报等，这样便于以后查找。

张XX：你的项目文档在编码系统里是怎么样编的？

黄XX：比如说测试。包括测试反馈方面我们也专门有一套文档。这套文档是这样的，在测试的初期按照功能模块来，我们分为单元测试等。至于文件的编号则统一的比如xx系统第一次测试，里面有很多个文件，差不多的时候就拼成一个文件，用Word或Excel。

张XX：Software你要测试的话，首先要有一个Instruction，就是说如何去测，然后根据你这个指导书再去测，相当于一个实验报告。

黄XX：原来有些项目的客户就要求我们有测试计划。测试计划里边包含测试样例，输入是什么东西，输出是什么东西等。现在软件测试还包括很多东西，包括软件功能有没有达到，如逻辑功能，我输入某个东西，在某一块是否输出什么东西。我们以项目为主，每个项目有一个编号。

张XX：那假如说想找一个几年前的项目，怎么样很快的去找到。

黄XX：就是在Vsourcesafe里的项目的目录里源代码、数据库、文档等这些方面都有。如果配置管理做好，这些问题就可以搞定。起码这些文件在逻辑上是可以找到的，在物理上可能是一个文件。
另外在我们配置管理里面有这种编号，就有点像顺序号，如果他是文档的话，我们就叫Doc001，就是针对项目里面的，但这些主要是用来配置管理自己看一看的。

surfacer · 发表于 2012-4-16 12:10:41

主持人：那是自然，做得再好都会说不好用，模版要工程师去做，让他们自己做他们不会说不好用的。工程师觉得模板不好用，但他又拿不出一个更好用的模板来，而且他说的都是客观存在的理由，举例告诉你这里为什么不好用。

熊 X：但模板是可以慢慢的修改，先做个初步的出来。我们会在成型文件里会说预研报告要包括市场调研、市场分析等。

张XX：在一个Project 开发的过程中，有没有一个单独的文件，规定在什么阶段出什么文件。就是说在这个Project一开始就已经规定了在什么时间出什么文件，因为不同的Project 是不一样的。

熊 X：有。而且这些文件都要评审的。我们一开始就会有几张纸出来，列出哪些是要评审的，这个(资料)就交给项目组，给他们看。你要经过这些，然后输出什么文档，最后就是文员在那里打对勾，相当于一个Check List ，然后可能会增加一些评审点，那就在后面加。后来会发现评审多了一些，比如客户突然有什么反馈呀，就是说固定的评审他必须做。

张XX：真正要把一个Project文件搞齐备的话，真的很麻烦。

熊 X：而且最大的问题不是有没有，而是时间上对不对的上，就是说应该是1月1日出的文件，可能到7、8月才有这个文件。明天又是内审，那个内审员最清楚我们的问题就是时间对不对的上，每次文件都有，但是一看：预研评审是在1月1日，为什么你这个文档还在7月还在填。这就类似于用ISO来检查前伪造文档。

刘 X：我想问一下，现在有一些文档管理的软件，里面也反映了基线。版本反映在软件里面了，而且实时可以去提供的，是根据服务器网络来，大家有没有考虑用这种软件。
前段时间北X青X到我们公司来推荐软件，当时一个是经费的问题，另一个问题就是他向我做介绍的时候，也说了一些像我们这样的公司在用他们的软件，还给出了某一个项目里面的具体的文档，然后对我说这是比较机密的资料，具体内容不能让我看，但还是有一些具体的内容出来了，我在想，因为这都是和服务器挂上的，会不会在这些软件里边会有后门，会不会我们在用这些软件的时候他就已经知道我们的技术资料了。

黄XX：那要看你的网。比如政府的内网和外网是彻底隔离的。就是物理隔离。

张XX：基于web的话是很方便的，但安全是一个问题，我们现在已有一个客户在用基于oracle和metaphase而开发的系统，我们现在要进入这个系统要四个code，一个username ，一个password还有一个pincode，还有一个number，这个随机number专门有一个生码器生成它，在我把Pincode 输完后再输入这个随机码。生成哪个码就是这个码。

黄XX：我们给客户的都用活体指纹。

熊 X：我们就用钥匙，密码和人分离的方法。

jixiexu · 发表于 2012-4-13 15:43:42

我们在管理也存在这样的问题，往往看的不够远，事情过后发现很多事情有矛盾，但改正却要花费很大功夫，甚至忙不过来，以至于错误继续……

universal · 发表于 2012-4-13 13:18:13

显而易见，因为不会研发，所以才不知道什么时候出文档，文档该怎么出，怎么管理。补一句，研发方式也是有好几类模型的，往往有例可援

		自动登录	找回密码
密码			注册会员

一次“研发文档管理体系建设”沙龙实录

点评

评分