（工商管理专业论文）UT斯达康客户文档开发过程改进研究.pdf

学位论文原创性声明 本人郑重声明：所呈交的学位论文，是本人在导师的指导下，独 立进行研究工作所取得的成果。除文中已经注明引用的内容外，本论 文不包含任何其他个人或集体已经发表或撰写过的作品成果。对本文 的研究作出重要贡献的个人和集体，均已在文中以明确方式标明。本 人完全意识到本声明的法律结果由本人承担。 学位论文作者签名：杠妻链 日期：) 叼年9 月，多日 学位论文使用授权声明 本人完全了解中山大学有关保留、使用学位论文的规定，即：学 校有权保留学位论文并向国家主管部门或其指定机构送交论文的电 子版和纸质版，有权将学位论文用于非赢利目的的少量复制并允许论 文进入学校图书馆、院系资料室被查阅，有权将学位论文的内容编入 有关数据库进行检索，可以采用复印、缩印或其他方法保存学位论文。 学位论文作者签名： 导师签名： 杜素锐 铬竹 曰期：2 叩7 年歹月，多目 u t 斯达 摘要 客户文档是指可以交付给客户使用的产品手册、软件在线帮助和其他相关 文档，通讯设备制造企业非常重视客户文档的开发工作，设置专门职位和成立 专门部门，投入大量人力和物力，力求丌发出高质量的客户文档。但是客户文 档开发在中国的历史较短，没有积累起丰富的经验，因此有时无法正确解决一 些有关客户文档质量的问题。本论文将以u t 斯达康公司客户文档开发实践为 研究对象，运用软件工程理论和工具，分析影响u t 斯达康公司客户文档质量 的原因，指出为了确保客户文档的质量，必须在客户需求分析、文档开发流程 的规划与管理、文档工程师的激励等方面做出改变。随着中国制造业的发展， 越来越多的中小规模企业开始重视客户文档的开发，他们想认识客户文档开发 的基本规律，了解影响客户文档质量的主要因素，从而迅速提高客户文档的质 量，本论文将给予此类企业在客户文档质量管理方面一定的启发与帮助。 关键词：客户文档，用户手册，需求管理，软件开发模型 r e s e a r c ho nu t s t a d e v e l o p m e n tp r o c e s si m p r o v e m e n t m a j o r ：m a s t e ro f b u s i n e s sa d m i n i s t r a t i o n n a m e ：d uj i a m i n g s u p e r v i s o r ：x ud o n g s h e n g a bs t r s a c t j i a n gw e n n i a n c u s t o m e rd o c u m e n t a t i o nm e a n ss o m ed o c u m e n t sw h i c hc a l lb ed e f i v e r e dt o c u s t o m e r sf o ru s i n g ，i n c l u d i n gp r o d u c tm a n u a l s ，s e t , w a r eo n l i n eh e l pa n do t h e r r e l a t e dd o c u m e n t s t e l e c o m m u n i c a t i o ne q u i p m e n tp r o v i d e r sa t t a c hg r e a ti m p o r t a n c e t ot h ed e v e l o p m e n to fc u s t o m e rd o c u m e n t a t i o n , a n di no r d e rt od e v e l o ph i g h - q u a l i t y d o c u m e n t a t i o n , t h e s ec o m p a n i e ss e tu ps p e c i a l i z e dp o s t so re v e na l li n d e p e n d e n t d e p a r t m e n ta n dp u ti nal o to fh u m a na n dm a t 谢a lr e s o u r c e s h o w e v e r , b e c a u s et h e h i s t o r yo f c u s t o m e rd o c u m e n t a t i o nd e v e l o p m e n ti sv e r ys h o r ti nc h i n a , t h e r ea r en o t al o to ft e c h n i c a lw r i t i n gw o r k i n ge x p e r i e n c e s ，s oi ti sd i f f i c u l tt od e a lw i t hs o m e d o c u m e n t a t i o nq u a l i t yp r o b l e m s t h i sp a p e rf o c u s e so nt h ed e v e l o p m e n to fc u s t o m e r d o c u m e n t a t i o ni nu t s t a r c o m , a n da n a l y z e st h ef a c t o r sw h i c hi n f l u e n c et h eq u a l i t y o fc u s t o m e rd o c u m e n t a t i o nw i t ht h et h e o r ya n dt o o lo fs o f t w a r ee n g i n e e r i n g t h i s p a p e rp o i n t so u tt h a ts o m ec h a n g e sm u s tb em a d ei no r d e rt oe n s u r et h eq u a l i t yo f c u s t o m e rd o c u m e n t a t i o n , i n c l u d i n gc u s t o m e rr e q u i r e m e n ts u r v e y , t h ep l a n n i n ga n d m a n a g e m e n to fc u s t o m e rd o c u m e n t a t i o nd e v e l o p m e n tp r o c e s s ，a n dt e c h n i c a lw r i t e r i i m o t i v a t i o n w i t ht h ed e v e l o p m e n to fc h i n a sm a n u f a c t u r i n gi n d u s t r y , m o r ea n dm o r e s m a l la n dm e d i u m - s i z e de n t e r p r i s e sb e g i nt op a ya t t e n t i o nt ot h ed e v e l o p m e n to f c u s t o m e rd o c u m e n t a t i o n , t h e yw o u l dl i k et ok n o wt h eb a s i cr u l e sa b o u ti ta n d u n d e r s t a n dt h ef a c t o r sw h i c hi n f l u e n c et h eq u a l i t yo fc u s t o m e rd o c u m e n t a t i o ni n o r d e rt or a p i d l yi m p r o v et h eq u a l i t yo fc u s t o m e rd o c u m e n t a t i o n , t h i sp a p e rw i l lg i v e t h e ms o m e i n s p i r a t i o na n dh e l p k e y w o r d s ： c u s t o m e rd o c u m e n t a t i o n , u s e r m a n u a l ，r e q u i r e m e n t m a n a g e m e n t ，s o t t w a r ed e v e l o p m e n tm o d e l i i i 目录 摘要i a b s t r s a c t i i 目录i v 图表目录v i 第l 章绪论1 1 1研究背景1 1 2 研究方法一2 1 3研究意义3 1 4 结构安排一4 1 5本章小结4 第2 章理论综述6 2 1 客户文档与文档工程师6 2 2目前的文档开发过程控制措施及其局限性7 2 3客户文档的需求。9 2 4 文档开发过程模型1 1 2 5本论文的创新之处1 2 2 6本章小结1 2 第3 章u t 斯达康客户文档开发过程分析1 3 3 1总体介绍1 3 3 2客户文档质量控制体系15 3 3全面质量管理模型1 9 3 4客户文档开发过程分析2 0 3 5对过程改进的需求2 6 3 6本章小结2 7 第4 章客户文档开发的需求管理2 8 i v 4 1多视点需求工程方法2 9 4 2获取客户文档需求2 9 4 3判断需求不一致的规则3 3 4 4对需求不一致的处理3 4 4 5本章小结3 5 第5 章客户文档开发模型的改进3 6 5 1文档开发流程3 6 5 2文档开发流程的规划3 7 5 - 3文档开发流程的管理4 2 5 4文档工程师对过程改进的影响4 4 5 5本章小结4 9 第6 章总结与展望5 0 参考文献5 2 后记5 4 v 图3 - 1 技 图3 - 2u t 图3 - 3 全 图5 - 1 文 图5 - 2 文 图5 - 3 考 图5 - 4 马 表目录 表3 - 1客户文档的关键质量控制点。1 7 表4 - 1需求调查的规程3 0 表5 - 1客户文档开发流程中可以优化的环节4 0 表5 - 2 文档开发流程中的目标考核管理4 2 表5 - 3 影响客户文档质量量化控制指标的因素4 4 v i 1 1研究背景 第1 章绪论 通讯设备制造企业是指致力于移动、宽带、i p 、光网络、电信增值业务和 终端等多个领域产品生产和服务提供的企业，一般在全球设有多个研发中心和 分支机构，以创新并富有竞争力的产品和专业服务拓展全球通信市场，国内有 影响力的制造企业包括华为、中兴和u t 斯达康等公司，国外厂商则包括诺基 亚、爱立信和摩托罗拉等著名企业。 这些制造企业生产的通讯设备往往是成套的大型设备或系统解决方案，包 括各种软硬件产品，设备价值高达百万或千万人民币左右，功能复杂、设备安 装和维护要求高。客户文档是指随设备或产品一起交付客户使用的随机资料， 包括用户手册和软件帮助系统等，这些资料能够帮助用户了解和熟悉设备、正 确使用和维护设备，同时可以节省制造企业售后技术支持的成本。 设备的大型化和复杂化，导致客户文档开发的项目化和复杂化，为了开发 出高质量、满足客户要求的文档，在大型通讯设备制造企业中，一般都设有独 立的客户文档开发部门来承担此类任务，例如华为公司的客户文档开发部门有 超过1 5 0 0 名的文档工程师在工作，u t 斯达康公司的客户文档开发部门也有5 0 人左右的团队给公司提供客户文档支持，客户文档的质量管理已经成为一项重 要的产品质量管理内容。 但是，客户文档毕竟是一种不同于其他软硬件产品的文字作品，很难直接 使用已有的质量管理方法来控制其开发的质量。同时，由于客户文档的开发在 国内尚属起步阶段，有丰富文档开发管理经验的人较少，因此在实践工作中经 常会出现以下问题： ( 1 ) 客户对文档的质量要求越来越高。随着公司业务的发展，外部和内部客 户对产品文档的质量要求在逐步提高，抱怨也在不断增加。外部客户即运营商， 内部客户则包括公司内部的测试工程师、技术支持工程师和销售工程师等。外 】 部客户对客户文档的依赖程度低，抱怨大部分来自公司内部的技术人员，主要 的抱怨是客户文档的实用性和可操作性较差，不能满足设备安装和维护的需要。 ( 2 ) 缺乏对客户文档质量的有效定性或量化控制手段。没有有效的控制手 段，文档质量就不能得到保障，基于文档质量的员工绩效评估也就无法展开， 员工的工作表现好坏很大程度上取决于管理者的主观评价，因此文档工程师的 工作积极性偏低，激励措施失去了针对性。 ( 3 ) 公司内部的知识管理与知识分享出现了问题。客户文档的开发首先需要 对来自公司研发等部门的所有相关资料进行收集整理和学习，但是这些部门与 客户文档开发部门之问的信息沟通、资源共享渠道往往并不通畅。文档工程师 无法及时获取到最新完整的研发文档和相关技术资料，公司没有整体的信息管 理或知识管理架构和运行机制，研发工程师、技术支持工程师也没有动力进行 知识分享。 ( 4 ) 文档工程师的职位要求与实际工作之间存在差距。文档工程师自身的技 术背景和学习能力对于文档质量的提高非常关键，但是现有的员工招聘和入职 后的继续培训学习常常忽略了这一点。另外，客户文档开发没有形成专业分工， 每个文档工程师都被要求能够写作系统概述手册、安装手册、操作手册和维护 手册等，而这种要求在某些情况下显得很不合适。 上述这些问题在不同程度上均与客户文档的质量问题有关，解决质量问题 的实质在于消除产生质量问题的原因，本论文将在软件工程理论和工具的指导 下，通过对u t 斯达康公司客户文档开发实践的研究，发现影响其客户文档质 量的主要因素，然后提出改善客户文档质量的主要措施，其他通讯设备制造企 业或高科技公司的客户文档开发部门也可从本论文中得到有益的借鉴。 1 2研究方法 本论文希望通过对u t 斯达康公司客户文档开发部门“技术沟通部”的开 发实践研究，得到具有普遍指导意义的研究结论，这是一个从特殊到一般的归 纳研究过程。 u t 斯达康公司的客户文档开发部门从无到有，文档工程师最多时达8 0 余 2 人，从最开始主要负责技术资料的英汉、日汉翻译，发展到现在直接开发中英 文产品客户文档，与公司一道经历着充满机遇和挑战的快速发展历程。在通讯 设备制造企业中，u t 斯达康公司的文档开发规模和工作流程具有比较典型的 代表性。 为了很好的进行研究，本论文将在软件工程理论和工具的指导下，对影响 u t 斯达康公司客户文档质量的主要方面或环节进行充分研究，包括客户需求 分析和开发流程等。 1 3研究意义 在国内，面向客户的技术写作是一个较新的职业，仅在少数具有一定规模 的高科技公司中才设有文档工程师这一职位和客户文档开发部门，所以缺乏成 熟的管理体系和管理经验指导实践工作，在很多情况下，只能凭借不断积累的 工作经验来推动技术写作的进步，但是这种情况是无法适应快速发展的中国制 造企业对客户文档质量要求的，而国外的技术写作已经发展到一定程度，有较 为完整的体系和经验可供借鉴。 另一方面，客户文档的质量管理不同于其他产品，有其独特之处，例如， 无法用简单的数量标准来直接控制客户文档的质量，客户文档的质量检测方法 和标准较为主观等。 软件工程理论和工具在客户文档质量的控制方面仍然是有效的，只是需要 进行有针对性的变化而已。因此有必要在研究国外先进的技术写作理论和实践 的基础上，在软件工程理论和工具指导下，探讨符合国内实际情况的客户文档 质量管理理论和方法。 本论文是基于u t 斯达康公司的客户文档开发实践进行研究的，研究成果 可以直接应用于公司的客户文档写作实践。同时，很多国内企业的客户文档开 始由专门的文档工程师编写，并且设立专门的部门管理客户文档的开发，本论 文的研究成果将在一定程度上给予他们启发和帮助，高质量的客户文档将可以 使企业节约时间、赢得合同和留住客户，从而创造出价值。【l 】 3 1 4结构安排 本论文共分六章，在论文的前面部分将介绍研究的背景、方法和意义；目 前客户文档质量控制措施的具体内容及其局限性；以及将要使用的质量分析与 改进理论和工具。然后是对u t 斯达康公司客户文档开发实践的介绍，以及对 客户文档质量的分析过程和客户文档质量的改进措施。论文的最后部分总结了 研究成果和未来客户文档质量改进过程中需要进一步关注的事项。 第一章是“绪论部分。主要内容包括研究背景、研究方法、研究意义和 论文的结构安排等。 第二章是“理论综述 部分。主要内容包括论文中的主要概念、目前主要 的客户文档质量控制措施、论文研究将要使用的理论和工具，以及本论文的创 新之处等。 第三章是“u t 斯达康客户文档开发过程分析 部分。主要内容包括u t 斯 达康公司客户文档开发的总体介绍、客户文档的质量控制体系和引入全面质量 管理模型对开发过程进行详细的分析等。 第四章是“客户文档开发的需求管理 部分。主要内容包括多视点需求工 程方法的介绍，以及获取客户文档需求的方法和判断需求不一致的规则等。 第五章是“客户文档开发模型的改进”部分。主要内容包括文档开发流程 的规划和管理，以及文档工程师对过程改进的影响等。 第六章是“总结与展望”部分。主要内容包括对研究结果进行的概括，并 指出论文的局限性和有待进一步研究的问题等。 1 5本章小结 本章介绍了通讯产品客户文档质量分析与改进的研究背景，指出随着中国 制造业的不断发展，作为产品组成部分的客户文档，其质量受到越来越多的关 注。但是客户文档开发在国内的发展历史较短，还没有积累下丰富的经验和建 立起成熟的理论来指导实际工作，因此有必要在软件工程相关理论的框架下， 借鉴国外的理论与经验，以u t 斯达康公司的客户文档开发实践为研究对象， 4 探讨如何提高客户文档的质量。 要进行客户文档质量的研究，就必须明确与客户文档质量有关的定义和概 念；目前主要的客户文档开发过程控制措施及其局限性；以及将要使用的软件 工程理论和工具，这些相关内容将在下一章进行介绍。 5 第2 章理论综述 2 1客户文档与文档工程师 通讯产品客户文档是指可以交付给客户使用的产品手册、软件在线帮助和 其他相关文档。本论文将主要讨论产品手册中的安装手册和操作手册，这两类 手册对客户特别重要，客户文档开发过程的改进研究也将以提升这两类手册的 质量为主要目的。 由于目前的电信设备安装和维护工作一般由电信设备制造企业的技术人员 负责，因此安装手册的使用对象主要包括电信设备制造企业自身的测试工程师、 技术支持工程师和其他人员。而操作手册的使用对象则包括电信设备制造企业 的技术人员和电信运营商的技术人员，即内部客户和外部客户两类人员。 虽然安装手册的使用对象主要为电信设备制造企业的技术人员，但是该类 手册会同时交付给电信运营商使用，所以安装手册与操作手册一样，其开发过 程需要严格执行既定的流程，以同时满足手册形式和内容两方面的要求。 本论文提及的文档工程师是指为开发客户文档专门设置的职位。文档工程 9 币( t e c h n i c a lw r i t e r ) 的基本职责就是基于产品设计和研发活动，采用工程化的方 法和面向用户的思想，负责编写或组织编写系统概述手册、安装手册、操作手 册、维护手册等产品随机资料及软件帮助系统，以支持产品的正常运行、维护 和培训，“他们最重要的作用就是把非常专业的技术知识变得通俗易懂”。作为 产品开发的一个组成部分，文档工程师需要与软硬件开发工程师、测试工程师 和技术支持工程师一起紧密协作，这样才能开发出高质量的客户文档。 由于文档开发工作需要多方面的信息资源输入，因此要求文档工程师具有 很好的沟通能力，同时，文档工程师需要保证客户文档的可靠性，其中一个方 法就是文档工程师亲自验证自己所开发的文档，这就要求文档工程师具备一定 的技术基础和动手能力，而不仅仅是对少字内容的整理与编辑。 在国内，文档工程师主要包括中文文档工程师和英文文档工程师，分别完 6 成中英文客户文档的开发工作，在某些情况下，还需要能够精通同语、法语或 葡萄牙语等语种的文档开发人员。随着中国经济全球化的发展趋势，英文文档 工程师的需求越来越旺盛。 2 2目前的文档开发过程控制措施及其局限性 在目前的实际工作中，主要通过以下三个方面来保证客户文档的质量达到 一定的要求：制定文档样式模板；聘用具有丰富经验的文档工程师；使用功能 强大的i t 信息技术和开发工具。【2 】 这些控制措施能够发挥积极的作用，但同时也具有一定的局限性。 2 2 1 制定文档样式模板 文档开发最基本的标准是统一的文档样式模板，这样开发出来的文档将具 有一致的外观、编辑排版方式和内容结构等，尤其是多个研发中心的文档工程 师共同完成一个文档开发项目时，执行统一的标准会减少相互之间的协调和适 应工作，可以更加迅速的完成既定的项目。 局限性：样式模板的制定仅仅是最基础的工作，内容模板的制定才能进一 步提高客户文档的价值，内容模板定义了某一类产品的客户文档必须包含的内 容，这是在研究目标客户的需求基础之上完成的。内容模板还倡导基于任务的 描述方式，【3 】对特定的任务给出完整的描述内容，同时内容模板还对写作风格 做了统一的规定，要求不同的文档工程师在描述同样的内容时要采取同样的写 作方式。在稍具规模的文档开发团队中，有专门人员或小组负责文档样式模板 和内容模板的研究与制定工作，通常这些人员都是具有丰富文档开发经验的资 深文档工程师。 2 2 2 聘用具有丰富经验的文档工程师 一个优秀的文档工程师通常具备这样的能力：熟悉写作技术、能够制定文 档样式模板和内容模板；很好的沟通能力来获取所需的信息资源；扎实的文字 7 表达能力，能够把复杂的问题用简单易懂的方式呈现给客户；较强的学习能力， 面对陌生的技术领域，可以在较短的时间内掌握到一定程度。 为了提高文档开发的效率，文档开发工作逐渐形成了分工的局面。编辑排 版专家专心设计优秀的文档样式模板，并对文字进行专业排版操作，图形优化 人员则负责制作规范的图形、图表，这样专门负责文档写作的文档工程师可以 有更多的精力投入到文档开发工作中去。 局限性：在国内，具有丰富经验的文档工程师很少，熟悉文档开发各个环 节的人更少，而且企业的人力资源部门或其他相关部门普遍认为文档开发是一 个技术含量不高的职位，不需要特别的能力就能胜任该工作，但实际情况是， 没有五年以上文档开发经验的人很难对文档开发工作有深刻的认识并在此基础 上进行变革。随着中国制造业水平的提升，这一情况或许可能改变，但是需要 各个方面的共同努力。 国内的各个企业在聘用经验丰富的文档工程师时，基本上只能在大型高科 技企业中找到目标人选，众多中小型企业中还没有那么多符合要求的文档工程 师可供选择。 2 2 3 使用功能强大的i t 信息技术和开发工具 与技术写作直接相关的i t 信息系统就是知识管理系统了，文档工程师通过 该系统可以方便的获取到所需的信息资源，另外，文档写作管理系统和发布系 统也在很大程度上提高了工作效率。常见的开发工具则包括w o r d 、f r a m e m a k e r 、v i s i o 、p h o t o s h o p 和c o r e l d r a w 等软件。 局限性：企业具有知识管理系统，并不意味着文档工程师就可以完全依赖 这个系统来获取自己想要的文档资料，因为知识管理系统的有效运行是需要公 司制度来保证的，在实际工作中往往会出现文档上载不及时、所上载文档内容 过于简单、信息残缺等情况。“企业在构建自己的知识系统时，要引入知识权益 补偿机制，以合理公正的知识绩效制度来核查和评价员工的知识成果，以多样 化和明晰的知识奖惩制度来完成从智力资本到其他资本的转化，并针对不同类 型的知识员工给出富有个性化的评价和激励。 【4 】 总体而言，上述措施虽然能够发挥一定的作用，但是存在以下几点不足之 8 处： ( 1 ) 缺乏全面质量管理 ( 2 ) 对客户的需求分析不足且不成体系 ( 3 ) 对客户文档开发流程自身关注较少 软件工程理论和工具虽然更多地直接应用于软 论和工具也可用于客户文档开发的管理，例如全面 开发过程的管理；需求工程对于客户需求的开发和 选择和优化等。 2 3客户文档的需求 当客户购买了某一产品之后，在使用之前一般 包装出售的用户手册或其他资料，如果是复杂的大 之前接受设备生产厂商提供的培训，然后才进行设 产品还会提供软件帮助系统来解决客户可能会遇到 然解决不了问题时，客户会拨打售后服务电话来寻 厂商的技术人员到现场来解决故障。一旦发现客户 售数量的增加而增加、平均通话时间变长等现象， 产品安装和使用问题，那么相关人员就应该意识到 因为它们满足不了客户的实际需求。 客户文档面临的最大挑战就是满足用户不断增 求相比，客户文档需求的不确定性更加明显，究其 知性、人们认识能力有限等；【5 1 还与客户文档开发 丰富的理论和工具有关。 软件工程学是主要应用工程的方法和技术，研 工具和管理的一门计算机科学与工程学交叉的学科 以软件生命周期为基础，吸取工程的方法和技术， 化、科学化。传统的软件工程技术主要以结构化思 客户文档开发作为软件开发过程的一个组成部 9 方法论与工具来进行质量管理，其中有效的客户文档需求分析可以大大降低客 户对文档的抱怨，从而提高文档的质量。 2 3 1 客户文档需求中的多视点现象 那么什么样的客户文档才能满足客户的需求呢? 在回答这个问题之前，需 要明白所面对的客户是什么样的一些人群，他们如何使用客户文档等。有时候 所面对的客户是各种各样的人，他们对客户文档的要求也是千差万别的，有的 人觉得客户文档信息量不够，“消费者永远不会因为用户手册写得太罗嗦而投 诉 ，【7 】有的人则觉得内容太冗长和哕嗦：有的人喜欢阅读文字，有的人觉得图 形和图表更直观和亲切一些；面对同样的客户文档，有的人可以快速地查找到 相应的信息内容，有的人却抱怨文档结构太差，无法检索到自己想要的东西； 有的人习惯阅读印刷版客户文档，有的人更青睐电子版客户文档，因为这样的 文档便于传送和携带。那么如何满足各种各样客户的不同需求呢? 一个简单的 方法就是在客户文档中披露更多的信息，让不同的客户都可以在文档中找到自 己所关心的内容，但是文档开发是有成本的，披露越多，成本越高，而且出于 保密的要求，产品信息或技术细节的披露程度也是有严格限制的，即知识产权 可行性。 这就是客户文档需求中的多视点现象。“在构建复杂的系统时，往往涉及到 许多不同的参与者或者涉众( s t a k e h o l d e r ) 。由于这些参与者在构建系统或使用系 统的过程中，肩负着不同的使命与职责，同时也由于他们所掌握的技能和知识 各有侧重，获取信息的途径也有所不同，一般来说以上因素会导致他们对待构 建的系统的认识和看法均存在差异。一个视点( v i e w p o i n t ) 可以认为是某个或同 一类个体( 参与者) 对于论域( 待建系统) 的主观定义。 多视点需求工程的任 务就是要综合考虑不同涉众对于系统的理解、客观分析若干视点的内外部关系 并进行有机的整理和综合。【3 】 2 3 2 多视点需求工程中的不一致性管理 就像不同的客户对文档有着不同的需求一样，企业内部的不同人员也对文 档需求有着迥异不同的理解。项目经理的要求很简单，就是在开发的各个阶段 1 0 客户文档的状态能够符合项目的计划即可，不要出现拖延项目周期的事情发生； 产品经理对客户文档的成本比较敏感，因为在某些情况下，客户文档会被免费 赠送给客户，并不单独定价；销售经理比较在意客户文档的外观是否有吸引力， 印刷精美、装帧考究就是他们对客户文档的标准：研发人员则对客户文档中技 术内容的完整性和j 下确性比较关心，但是完整性也并不意味着要把客户可能需 要的全部信息内容都包括在客户文档中去。 最终在如何满足客户需求这个问题上，各方无法达成一致的意见，文档工 程师也会在如此复杂局面下失去自己的主张。 需求工程的研究人员提出了六个关键活动来处理需求的不一致：重叠需求 的发现；不一致性需求的确定；不一致性需求的分析；不一致性需求的处理； 对于处理的评估；追踪。【9 】 本论文的第四章将集中讨论如何获取客户文档需求、判断和处理不一致的 客户文档需求等内容。 2 4文档开发过程模型 为了更好的满足客户对文档的需求，除了进行有效的需求分析之外，文档 开发过程模型可以采用原型模型( 又称为演化模型或进化模型) 来进一步确保 客户的需求能够得到实现。原型模型的基本思想是：在与用户进行需求分析的 同时，以比较小的代价建立一个能够反映用户主要需求的原型系统。用户在原 型上提出改进意见，分析人员根据用户的意见，补充完善原型，然后再由用户 评价，提出建议，如此往复，直到开发的原型系统满足了用户的需求为止。通 常原型系统是用户可以操作的系统，系统中已经包括了用户的需求，用户通过 实际操作，比较容易发现漏掉的需求。【1 0 】 原型模型又有多种形式：丢弃型、样品型和渐增式演化型。原型模型也是 通过构造系统的各个可执行的中间版本来开发系统的，但是，与渐增模型的区 别是承认需求不能被完全了解，且不能在初始时就确定。在原型模型中，需求 一部分被预先定义，然后在每个相继的中间版本中逐步完善，每个中间版本在 开发时，开发过程中的活动和任务顺序地或部分重叠平行地被采用。【l l 】 1 】 2 5本论文的创新之处 在国内，华为拥有规模最大的客户文档开发部门，他们具有丰富的文档开 发经验，但是公开发表的有指导意义的文章并不多，另一方面，华为的研发体 系和文档开发实践并不适合其他中小规模企业模仿。国外的文档开发已经发展 到较高的水平，文档开发的各个方面都有较为丰富的文章、著作和标准发表， 但是中国的文档开发实践毕竟与国外相比有很大差距，例如国外的优秀文档工 程师通常是具有几十年丰富工作经验的资深技术专家，然而在中国，这样的资 深技术专家很难安心从事这项基础的技术工作，因为中国高科技行业的人才更 新速度远远高于国外。 随着中国制造业的发展，越来越多的中小规模企业开始重视客户文档的开 发，他们想认识客户文档开发的基本规律，了解影响客户文档质量的主要因素， 从而迅速提高客户文档的质量。因此，本论文将以u t 斯达康公司的客户文档 开发实践为研究对象，结合国外客户文档开发的理论与经验，给予此类企业在 客户文档开发过程管理方面一定的启发与帮助。 本论文利用软件工程理论和工具来分析u t 斯达康公司的客户文档开发实 践，特别是需求工程和文档开发过程模型的引入，将对充分了解客户需求和优 化文档开发流程等方面起到很好的作用。 2 6本章小结 本章首先定义了所研究客户文档的具体类型以及文档工程师的主要职责。 目前主要采用三种方法来控制文档开发过程：制定文档样式模板；聘用优秀的 文档工程师；使用强大的文档开发工具。但是，仅仅使用这几种方法无法从根 本上提高客户文档开发过程的效率，需要系统的研究客户文档开发过程，找到 有待改进的地方。因此本论文引入软件工程中的需求工程和开发过程模型等理 论，在后续章节中使用全面质量管理模型对u t 斯达康公司的客户文档开发过 程进行较为深入的研究，希望能够全面分析客户文档的需求，优化目前的文档 开发流程，从而最终改进客户文档开发过程。 12 lllllllllllllllll。2。lll。卜 3 1 1 技术沟通部 u t 斯达康公司的客户文档丌发部门是技术沟通部，主要负责技术文档、 软件帮助系统和部分市场文档写作及其管理工作，该部门作为公司知识管理系 统的一个组成部分，输出包括产品手册、软件帮助、宣传彩页、技术建议书和 产品白皮书等多种类型和中英文两种语言的信息资源。 技术沟通部是公共工程部的一个分支部门。公共工程部的部门目标是通过 建立统一工作平台和发挥在公共流程、工具开发、网络管理系统、增值服务系 统、元器件工程、性能认证、计算机辅助设计、机械工程、大规模网络互用性 测试、人因工程学、工业设计和客户文档的专业优势来提高公司的研发效率。 ou t 斯达康公司内部网卜的公司介绍内容。 1 3 图3 - 1技术沟通部在组织中的位置 技术沟通部由多个团队组成，分布在杭州和深圳两个研发中心，每个团队 负责本地研发中心研发的一个或数个产品线的全部客户文档，协调工作由杭州 研发中心的文档开发部门负责，包括制定统一的文档模板、管理文档发布系统、 印刷和发放产品手册与宣传彩页等。杭州文档开发部门与深圳文档开发部门相 互独立，并无直接领导关系。 技术沟通部的文档工程师分为中文文档工程师和英文文档工程师两类人 员，分别完成中英文技术文档的写作，但是随着研发项目和市场的要求，中英 文文档工程师的工作职责逐渐合二为一，文档工程师已逐渐能够独自完成中文 版本或英文版本的客户文档，不再需要中文文档工程师完成中文文档，然后再 由英文文档工程师翻译成英文文档，这是对文档工程师一个非常大的挑战，但 1 4 同时可以提高工作效率、节约协调成本。在任务突增的情况下，外包公司的文 档工程师也会临时加入到团队中一起工作。 3 1 2 客户文档开发工作 客户文档开发的具体工作内容如下： ( 1 ) 项目管理。包括文档的规划、编写、上载、版本控制以及印刷前的准备 工作；协调合资公司和o e m 厂商的文档工程师开发符合公司标准的相关文档； 对本研发中心以外的研发项目提供文档支持等。 ( 2 ) 技术文档开发。包括按照项目经理制定的总体项目计划，制定相应的文 档开发计划；控制文档在各个开发阶段的状态和质量；以基于任务的方式编写 软件帮助系统；安排公司内部或外包公司的英文文档工程师翻译技术文档，并 审校翻译稿件；处理有关技术文档的问题反馈；协调文档开发团队与公司研发、 技术支持和销售等其他团队的关系等。 ( 3 ) 市场文档开发。包括内容组稿、文档排版、语言检查和修饰、图形优化 和印刷前检查；研究产品经理提供的市场需求分析、竞争对手的产品市场战略 和业界的产品趋势分析；与项目经理、产品经理和销售团队等紧密协作，确保 所开发文档符合公司的产品市场战略等。 ( 4 ) 文档质量分析与改进研究。包括研究文档开发标准；制定文档的样式模 板和内容模板；学习先进的文档写作工具与技术；优化客户文档开发流程等。 3 2客户文档质量控制体系 u t 斯达康公司的客户文档质量控制体系包括客户文档开发流程、关键质 量控制点和质量相关人员三个组成部分。 3 2 1 客户文档开发流程 客户文档开发流程是客户文档质量的根本保障，通过开发流程中设计的一 系列程序步骤、工作文档，控制开发流程每一个阶段的状态，最终确保开发出 1 5 符合质量目标的客户文档。 u t 斯达康公司客户文档作为产品的一个组成部分，其开发流程符合公司 产品开发流程的要求，流程包含五个g a t e ，每个g a t e 之间称为p h a s e ( 阶段) ， 共计六个p h a s e 。 产品开发流程 g a t elg a t e 2g a t e3g a t e 4 g a t e5 客户文档 开发流程 资料来源：u t 斯达康公司质量管理程序文件 图3 2u t 斯达康公司的客户文档开发流程 对于客户文档开发来说，需要在产品开发流程总体要求的基础上，针对文 档开发特点，制定出相应的客户文档开发流程，该流程由以下五个阶段组成： ( 1 ) 计划阶段 在本阶段，根据初步产品开发计划制定客户文档开发计划，客户文档开发 计划主要包括将要开发的文档类型、各个阶段的时间安排，同时评估文档开发 的工作量，客户文档开发计划需要经相关人员审阅通过。 ( 2 ) 规划阶段 在本阶段，主要任务包括：熟悉项目组同事；收集资料和素材；参加技术 培训；规划客户文档的内容架构，完成文档一二级标题大纲的设计。 ( 3 ) 编写阶段 在本阶段，根据系统需求说明、概要设计说明、详细设计说明、系统测试 报告、性能列表、b o m 清单和b e t a 测试计划等各类研发文档编写客户文档。 1 6 ( 4 ) 审校阶段 在本阶段，使用审校和验证两种方式来确保客户文档的正确性。其中，在 系统测试阶段，审校和验证主要包括：部门内部交叉检查；针对英文文档的语 言检查；产品经理、研发工程师和其他相关人员的审校；以及系统测试工程师 和文档工程师对客户文档的验证等。在b e t a 测试阶段，主要是技术支持工程师 对经过系统测试阶段审校和验证的客户文档进行再次验证。 完成了系统测试与b e t a 测试两个阶段审校和验证的客户文档，经过文档工 程师的修订并经审校和验证人员确认之后才能被正式发布。 ( 5 ) 维护阶段 在本阶段，对因各种原因导致需要修订的已发布客户文档进行修订，例如 产品m r 引起的修订、客户文档本身缺陷引起的修订等。 客户文档的修订是不可避免的，文档工程师应该及时收集从各个渠道反馈 的文档质量问题，并在相关人员的协助下完成修订工作。但是，要管理好因修 订造成的文档版本升级问题，以免现场使用出现混乱的情况。 除了客户文档开发流程中的五个阶段以外，文档的发布也是非常重要的一 个环节。客户文档达到发布条件时，文档工程师应该及时把电子版文件上载到 相应的文档发布系统中去，并通知相关人员。对于需要印刷的客户文档，文档 工程师则必须按照印刷前准备流程进行相应的准备工作。 3 2 2 关键质量控制点 为了确保客户文档在项目的各个开发阶段按时保质完成，在文档的开发流 程中设置了如表3 - 1 所示的质量控制点。 表3 - 1客户文档的关键质量控制点 文档开发阶段关键质量控制点主要作用 确定各个开发阶段的时间，评估文档开发 计划阶段客户文档开发计划 项目的难度和所需资源。 规划阶段客户文档大纲确定客户文档的内容范嗣和目录结构。 1 7 续上表 分阶段检查客户文档草稿，以便在早期的编 编写阶段客户文档草稿 写过程中就及时的发现问题。 审校阶段审校报告控制内外部审校的效果。 维护阶段 历史修订记录 跟踪和记录历史修订记录的详细信息。 3 2 3 质量相关人员 除了文档工程师在开发过程中按照既定的流程与标准开发满足质量要求的 客户文档之外，其他人员也在客户文档质量的控制方面发挥着重要作用。 q a ：q a 负责在流程中的各个环节，检查文档工程师对流程执行的具体情 况和效果，增强流程的执行力。q a 对每个项目评估的结果，将会作为年中及 年底每人考评的参考。该角色一般会由部门经理或主管指定，并在有必要时聘 请其他部门人员担任。 产品经理：根据项目需要，了解并及时提供客户对客户文档的需求；参与 客户文档的规划；审校客户文档大纲、初稿和终稿；帮助协调客户文档开发需 要的环境和资源；协助客户文档发放规范化。 项目经理：根据产品的开发计划，并结合文档开发的具体要求，与文档工 程师共同制定客户文档的开发计划；同时协助提供各类开发客户文档所需要的 原始资料；提供开发客户文档所需要的环境；参与客户文档需求、计划、大纲、 初稿和终稿的审校；及时传递产品项目变更的情况；将客户文档信息及时提供 给内外部客户。 研发n 试工程师：负责提供编写客户文档所需要的各类研发文档；提供必 要的技术支持；审校或验证客户文档的正确性、可用性和完整性；及时传递产 品变更的情况等。 技术支持工程师：参与客户文档规划；根据现场经验传递客户对客户文档 的需求；及时提供开发客户文档所需要的现场技术信息，例如维护经验等；提 供必要的技术支持；审校或验证客户文档的正确性、可用性和完整性。 培训人员：根据培训经验传递客户对客户文档的需求；提供编写客户文档 】8 所需要的相关信息；审校或验证客户文档的正确性、可用性和完整性。 3 3全面质量管理模型 u t 斯达康公司的客户文档开发有完整的流程控制，并且有明确的质量控 制点及其要求，但是，开发出来的文档却出现质量起伏较大、客户满意度不高、 文档工程师工作士气有时低落等现象，那么究竟在哪些环节上出现问题了呢? 在软件质量管理中，全面软件质量管理的模型强调软件开发项目中的所有 人员几乎都参与质量活动，只是介入的程度不同而已。【地】客户文档的开发也可 以使用该模型来进行质量管理，进行质量分析与改进工作，全面客户文档质量 管理的模型如图3 - 3 所示。 客户文档开发项d x ， 7 ji 。、 、 i 、： 、 ，一一一 l 客户文档开发过