从零起步建设技术文档写作、管理和发布系统

从零起步建设技术文档写作、管理和发布系统的案例分享

河北中兴汽车制造有限公司

一、背景介绍

河北中兴汽车制造有限公司（以下简称中兴公司）始建于1949年，是一家具有70余年历史，是中国轻型车创建者、国产皮卡的创始者、国家级高新技术企业、中国汽车出口第一品牌、是国家整车出口基地企业.主力皮卡产品性能同步国际、国内领先。为保定皮卡和SUV领域取得优势地位奠定基础

主要产品为田野系列、威虎系列、领主系列、威狮系列车型。专用车型涉及驾校教练车、考试用车、电力、通信、消防等。

联合国内外280余家供应商，拥有健全的海内外营销服务网络，国内拥有300多家经销商、近400家服务站；海外拥有渠道180家，并建立了8个海外KD工厂。

二、实践过程

中兴公司的技术传播工作始终致力于提高技术信息开发效率，降低维修成本，满足海内外市场需求，提升客户的满意度，所以几年来，一直在不断地探索与革新。

概括讲中兴公司技术传播工作主要经历了两个阶段

第一阶段：建立建全阶段（从无到有）

一、组织机构搭建

初期以临时抽调技术、管理、售后维修等人员成立项目组的形式组建团队，明确职能、职责，对人员进行技术写作基础、基本技能（包括文档写作工具、图片制作工具、相关法规）等培训，让写作人员明白手册编写需要考虑哪些因素。同时在编写过程中明确重点培养对象，项目完成后确定专业技术写作人员，成立技术写作团队，并根据实际工作，提炼工作流程，使流程对后期的工作更具指导意义。

二、基础技术资料的收集和手册开发

1、手册出版状态规划。

根据相关法规及用户需求，通过对标同行业的手册和公司现状，明确出版状态、规划手册结构，进而决定手册编写工具、图片制作工具以及收集资料的内容和形式，这对手册编写工作起着提纲挈领的作用。

2、资料收集和手册编写

技术写作人员拉动各专业所设计人员，以SBOM和车型配置为依据，以技术方案、标杆车资料、整车生产线资料、售后反馈信息作为编写手册的基础资料，以售后维修需求及用户需求信息为导向作为手册编制依据和方向。

其中整车生产线的资料主要是作为补充资料，包括部分数据采集、核对和拍照等。再根据手册要求结合其它资料通过word、indesign、photoshop等编写工具排版定稿，按规划的出版物状态输出各手册。

图片完善主要采用在现有资料基础上补充（图一）和全部拍照（图二），最大限度利用已有资源，节省人力，提高编写效率。

图一

图二

三、主要解决问题

1、填补了中兴公司威虎系列车型服务手册的空白。

此次编写工作前，中兴威虎系列车型缺失专用手册，备件、维修需要参考田野系列车型相关手册。而威虎和田野两个系列车型实车相差甚远，随着威虎车型增多，可借鉴内容越来越少。严重阻碍了售后市场备件、维修等服务工作。而第一阶段的服务手册编写则实现了手车与实车一一对应，填补了多年来售后市场的空缺，满足了售后市场对维修资料的需求，提升了用户满意度。

2、完善了组织机构

此次编写工作，则实现了手册、组织机构、专业人员的从无到有，填补了多年来售后市场的空缺，并满足了市场的备件信息、维修需求。

3、奠定了手册编写工作的基础

通过手册编写全过程的实践，总结结验，制定了《服务手册写作流程》和《服务手册编制规程》作为指导文件。使得中兴公司服务手册的写作和管理工作有据可依，提升了服务手册管理水平。为中兴公司手册开发工作奠定了坚实的基础。

四、存在问题及思考

随着公司海内外市场的不断拓广，开发车型的日渐增多。传统的线下的编写模式和出版物形式的弊端也逐渐暴露出来，再一次无法满足市场需求，影响公司形象。

1、排版耗时且版本不规范

随着车型增多、人员变动频繁、使用说明书、维修手册、零部件手册版本越来越多，手册因人工排版造成出版物格式的不统一也越来越明显，直接影响公司形象。

同时随着出版物地增多，技术写作人员的排版耗时占比也越来越多，市场竞争日益激烈的今天，这显然是事倍功半的事情。

2、信息更新、维护，不及时

车型不断改进、增多，配置增加，不可避免带来设计变更信息增多，再加上手册版本的增多，手册更新和维护工作几乎是成倍增长。手册编写人员的大量精力都耗在了查找手册，手册排版上，即便如此，也无法避免手册维护工作不到位，导致手册信息更新滞后或遗漏，给公司造成不同程度的负面影响甚至经济损失。

（案例：因发往海外的零部件手册是印刷版本，无法及时更新设变信息，导致外商在定传动轴时定错配件无法安装，直接损失运输费、配件费，还造成顾客抱怨。）

随着各种问题的暴露，手册编写工作的革新势在必行，服务手册从线下编写、管理转为系统编写管理也成为必然，即中兴公司技术传播工作进入第二阶段——提升阶段。

第二阶段： 提升阶段（人工编写到系统编写）

一、开发零部件信息管理（EPC）系统

EPC系统开发，首先实现了零部件目录系统编写和管理。

基于已有专业技术写作团队和相对完善的数据，EPC系统开发的主要目的就是提升，提升零部件手册编写、维护效率，提升零部件手册的管理水平、提高售后配件信息的准确率。

拉动海内外售后配件管理人员，收集市场对配件的需求，对配件信息存在的问题进行汇总分析，作为改进零部件信息管理的依据。制定数据管理方案、手册编写规则、图片制作标准等，以技术写作人员为核心，进行基础数据转换、录入和整理，售后人员录入零部件辅助信息，并及时和配件管理人员和相关部门沟通。实现了零部件信息线上编写和管理，提高了手册编写和维护效率，提高了输出质量，降低了编写成本，实现了零部件及时维护，实现了公司发布与海内外同步共享信息。

二、维修信息编写系统（ACM）和发布系统（TIS）开发

2016年八部委下发的《汽车维修技术信息公开实施管理办法》（交运发〔2015〕146号）文件，把市场对汽车维修技术信息的需求推向了一个新的高度。为了响应国家号召，更好的保护消费者合法权益，降低维修信息编写和发布成本，2021年带领团队引进了维修信息编写系统（ACM）和维修信息发布系统（TIS）。

1、人员具备能力和职能明确

系统的开发和引进，完全不同于传统的编写模式和流程。涉及部门广，人员多，所以相关部门人员对工作目标的明确、系统的熟悉和工作流程的掌握是工作开展的前提。

同样以成立项目组的形式，由研发中心维修信息编写人员（明确工作目标、掌握流程，明确公司维修信息现状）拉动，通过会议形式，组织相关部门领导牵头，从软件系统到硬件设备，从IT部门到研发、售后部门，明确职能职责具备能力。

系统软硬件环境，由系统开发公司与IT部门直接对接，明确终端的各项功能，实现资源合理配置，并负责硬件维护。

研发中心维修信息编写人员，是系统使用的核心人员，必须了解系统的使用、管理，上下序的信息衔接，现有数据优化方案，相关法规要求，相关部门现有职能职责，以更好的系统公司对接，实现引进系统的既定目标，保证系统在公司良好运行。

售后部门，直接掌握售后市场信息，主要担任的职能也是使用系统和对外发布信息为主，本着方便用户查询和维修的原则，在车系矩阵表搭建、模块拆分原则，模块内容介绍上，和设计人员紧密配合，积极反馈各种建议，随时沟通。

2、手册编写和内容管理

中途引进系统必然要面对大量的历史数据转换、当前数据整理录入和未来数据的规划，才能保证系统信息完善、使用便捷。

所以，前期和系统开发公司就需要充分的沟通，包括人员职能划分、数据结构、项目特征、系统原理，整体工作的统筹安排等全方位沟通。

1）历史数据转换

鉴于已经公开的历史数据，因不涉及技术内容更改，只是系统转换。在和系统开发公司沟通数据结构，明确出版物状态后。通过对标，和系统开发公司一起探讨转换方案，搭建数据矩阵图，拉动中兴公司售后相关人员配合数据整合、提供，历时5个月，系统开发公司协助完成了中兴公司A平台、K平台、G平台共109车款的54本维修手册，56本保养手册，25项技术通报的上传和发布。解决了中兴公司人员不足，对系统不熟悉的顾虑，也加快了系统开发整体工作的进度。

2）利用结构化管理，录入新项目数据。

A.如同整车可拆分为分总成和零部件一样，按法规要求同时结合系统部署，根据各个章节模块所含内容的多少、通用程度、所属系统、查找便捷性、编号规则等进行合理划分和定义，对图片尺寸、样式和编号进行明确规定，不同的章节授权相关专业所设计人员协助编写，保证了技术内容的准确性，又保证了录入内容的一致性，进而保证出版物的统一。

因车型、配置不同造成的同一模块具体内容不一样的章节、图片，赋予不同意义的编号识别管理，既保证了每个编号对应模块和图片的单一性，又保证了同一主题模块的不同状态识虽差别一目了然。方便查询和引用的选择。源于系统部署，既可以根据车型查到各模块内容，同时又可以从模块找到所在车型，实现双向查询，便于后期局部设计变更管理。

B.对供方资料管控

对于供方提供的资料，系统开设了免费端口。通过系统直接给供方注册帐号，供方管理通过自己的帐号登录ACM系统，便可实现通过ACM系统编写和管理手册。通过TIS系统发布手册。提升了自身编写能力，同时避免了中间转换手册出错机率，，也最大限度实现了供方和中兴公司（主机厂）信息同步更新，保证了中兴公司信息完整、准确。

对于已有成熟编写系统和资料的供方，中兴公司通ACM系统实现一键上传，然后通过链接和整车手册融为一体。直接省去了编写时间，降低人工，收到事半功倍的效果。

C.关联引用内容的管理

手册的很多模块往往都不是独立存在，经常会涉及到与其它内容关联或参考，对于需要关联或参考的内容以及负责编写的设计人员，通过系统部署，可以实现在线随时查阅，及时与负责资料编写的专业设计人员进行沟通，同时，通过系统对权限的设定，对查阅的资料无法更改。既保证了原设计人员负责资料的安全又实现了各模块之间及时对接，保证了引用内容完美对接且不重复介绍。

D.设计变更内容的管理

车型、配置的增加，设计变更的不定时性和内容不确定性，会随时涉及到不同模块、不同手册。传统编写模式出现的维护不到位等弊端，通过系统部署直接消除，只需基础模块更改，所有关联手册自动更新。

E.各系统之间有机结合

对于公司已有系统，如EPC系统，根据需要选取EPC中相关零部件信息，通过部署系统实现和TIS系统链接，无需再对数据进行加工和转换，只要完成EPC系统内数据处理工作，TIS系统即可实现同步更新，既降低了人工成本，同时提高了发布信息的及时性和准确性。

3、培训措施及效果

新生事物的引进，也是新理念的引进，不可避免会遇到阻力。首先需要打破传统观念，消除畏难情绪，同时更快的掌握系统使用，适应新的编写流程。针对不同人群，不同问题，采取整体宣贯培训、问题分类培训、个人单独指导、制作简易培训文档、录制小视频等多种培训方式。鉴于系统操作的便捷性， 95%的人员都能在经过1小时左右培训的时限内完全接受并能很好的运用系统进行编写。授权90%的专业设计人员参与手册编写，均可熟练掌握系统的操作使用。并积极使用系统。

三、成效反馈

中兴公司手册编写工作从无到有， 从线下到线上的变革，都是适应公司不同形式下的产物。都在逐步的提高编写效率，降低编成本。尤其是开发手册编写系统（ACM）和发布系统（TIS）后，直接消减了公司维修信息公开费用的支出，保证了公司技术资料永久性保存，提高了中兴公司技术资料对外窗口的形象。

1、降低编写成本，提高编写人员工作效率

传统word 、Indesign等线下编写模式，在整个编写过程中，排版会占用大量人工，仍然无法保证所有版本完全统一。引用系统则完全解决了排版问题，实现了自动排版。以中兴《威狮系列维修手册》为例，近1000页的手册，完成各模块编写后，用时不到10分钟，便可通过系统完成排版，然后一键发布或下载。

通过系统编写，编写人员不受时间和地域的限制，只要有网络，技术人员（手册编写人员）即使不在办公室，只要登录网页即可进行编写。充分利用碎片时间进行编写和更新。而且资料都在公司内部的服务器上，既方便使用，也不会造成资料流失，还保证版本的唯一性。

以威狮系列车型《维修手册》的编写为例。

2021年中兴公司威狮系列车型是一款全新车型，也是引进系统后第一个由全部启用系统编写的手册，整个手册编写过程由一名专业技术写作人员拉动、协调，95%的专业设计人员兼职，整个开发过程涉及人员培训（系统使用培训、基础内容编写培训），内容编审批流程，共历时约2.5个月，完成近1000页维修手册编写并发布。

2、发布成本降为零

从2016年国家八部委联合下发的《汽车维修技术信息公开实施管理办法》（交运发〔2015〕146号）至2020年，中兴公司一直通过第三方发布，2016-2020年间，仅发布费用一项就308万。（见附表），2021年上系统后直接降为零。

3、实现了公司技术资料永久性保存和便捷查找

人员流动是每个公司不可避免的事情，而传统的编写模式和资料管理模式是各种资料和手册都是保存在个人电脑，人员流动经常因交接不到位或工作疏忽造成资料丢失或无法查找，长久以来给公司和后续工作都带来损失和诸多不便，而编写系统的引用，所有编写人员登录的都是公司服务器，资料统一保存在服务器。

通过对标题、编号和内容，查阅人员还可以非常方便进行横向查找，并能找到对应负责人员，管理人员可对每个标题的进度实时察看。

4、满足法规要求，提升公司形象

《汽车维修技术信息公开实施管理办法》发布，这既是对汽车维修技术信息公开的要求，也是主机厂维修信息开发和编写能力的体现。作为主机厂，为了更好的保障社会上维修经营者、消费者的权益，及时维护和发布手册是责任也是义务。同时也是主机厂综合能力对外展现的一个窗口。

ACM系统和TIS系统的启用，法规要求的备件目录、召回、3C认证信息、技术通告、VIN编制规范、专用工具(软件）信息及购买渠道、适用具体车型电子控制系统的软、硬件版本识别号等信息在发布窗口一目了然，既很好的满足了法规要求，还非常方便用户查找。且无须任何发布费用。

四、经验启示

近二十年的技术写作工作和带领团队开发各种手册的经验，证明，随着时公司形式和社会需求的变化，技术写作在工作也需要与时俱进。遇到瓶颈时，束缚我们前行和突破的更多的是我们固有的思维，打破自己的思维去接纳更专业的方法，会为前进的方向打开一片天。

每一次变革，就是在当前的各种环境条件下，探索并实践更合理高效的技术传播途径，再从实践中总结经验，制定流程、规范性文件，作为公司技术写作指导性文件。使公司技术写作工作一直处于良性循环，并不断发展。使公司技术传播管理水平处于不断提升状态。

尤其是线上编写系统的开发，除了解决已知问题和诉求，同时也实现了很多专业功能，为日后技术传播工作的快速发展和中兴维修行业更快与国际接轨奠定了坚实的基础，在业界处于领先地位。