ZTE用户手册体系介绍.ppt

开发阶段，作为研发组中的文档组，文档架构师接受来自研发代表的开发任务，制作文档架构，制定开发计划。研发组配合输出研发素材。文档开发作为产品开发的一部分，文档开发部和项目组紧密配合，共同完成文档任务。 * 要输出高质量的文档，必须进行多方位的质量控制，包括： 1）评审研发素材，控制上游输出质量 2）文档开发部内部进行写作审核 3）项目组进行技术审核 4）程序类文档进行实验室测试 5）新产品文档进行试验局验证 * 文档开发部使用XML工具开发文档，能够输出PDF和HTML两种格式，不支持WORD格式。输出物可以多种样式，包括：印刷品、光盘、网站、电子文件 * 有关用户手册的问题，可以通过问题反馈系统CSC反馈，也可以直接发送邮件到DOC邮箱， doc@ 或者通过后面介绍的几种途径进行反馈，如800电话，文档专员，文档经理等。 * 用户手册开发流程 1）研发代表下发任务，并提供素材和审核支持 2）文档架构师制作文档架构 3）文档工程师、翻译工程师、制图员进行文档开发 4) 架构师审核写作 5）研发审核技术 6）程序性文档提交测试部测试 7）文档封装交付给用户 * * 文档开发部一共有11个开发团队，是按产品维度分的，由两位部长分区域进行管理。同时部门设立专业平台，包括开发工具、文档架构、专业培训、外包人员管理，为开发团队做业务上的支撑 * IA（架构师）：作为研发组中的文档代表，接受研发代表分配的任务。DE（文档工程师）、翻译、制图和信息管理员各司其职，在文档架构师的带领下开发文档。 * * * 用户手册开发主要遵循两个标准，GR454和DITA标准。 中兴通讯学院采用的标准主要是指GR454，这是由Telecode于1997年发布的。Telecode是由ATT的技术支持部门分拆出来的专门提供电信网络的运营支撑咨询和服务的公司，占据北美和欧洲市场80%的市场份额。 用户手册架构、内容、开发流程遵循GR454标准。 * 用户手册的写作遵循DITA标准。 * * 用户手册开发采用专业的文档管理平台，它分为三个部分： 第一部分是内容编制，采用XML的编辑工具，工具安装在分散的客户端电脑上。 第二部分是后台的集中内容管理CMS系统，它具有专业的文档管理功能 ，例如文档的版本管理，访问的权限管理，重用单元的管理，链接管理，和客户商的访问控制等。 第三部分是统一发布平台。它将样式表加载到写好的XML文档上，根据配置选项不同，发布出不同格式的文档，如PDF的 , CDROM 适合WEB浏览的HTML文档等。 * DOCMAP 规定了一整套文档的架构 由架构师基于GR454的主题区和子集进行设计 它定义了在这套文档中要包括的Topic信息，以及每个Topic的写作和审核任务分配给那个人 TOPIC Topic为带有标题和内容的信息单元，它是写作和重用的基本单元。一个文档可以包含一个或多个Topic 每个Topic的内容要独立要足够短，短到只描述单个主题或回答单个问题 每个Topic的内容要完整足够长，长到其作为独立的信息单元，具有完整的意义并可作为一个单元来编 PUBMAP PUBMAP指定了在最终输出物（如PDF手册、WEB或CDROM）中Topic组装（assemble）的顺序和相互关系 PUBMAP由架构师基于客户对手册的要求设计 PUBMAP由发布服务PE自动生成，不需要人员进行排版，格式转换等工作 * 下面是手册开发过程的一个示意图： 第一步，架构师（IA)进行DOCMAP设计，DOCMAP的设计在XML EDITOR中进行，设计完后需要经理评审等工作。 DOCMAP中不仅包含了需要的TOPIC,还包含了每个TOPIC应该分配给那位DE进行写作，那位SE进行审核等信息。评审完的DOCMAP上传到CMS系统中。 第二步，CSM根据DOCMAP的信息，将每个TOPIC分配给不同的DE。DE会自动收到自己的写作任务，然后在XML EDITOR中进行TOPIC的写作。写作TOPIC的过程上中，需要和CSM进行交互。写完的TOPIC最后上传到CMS系统。 第三步，架构师进行PUBMAP设计，PUBMAP的设计在XML EDITOR中进行。设计好的PUBMAP上传到CMS系统。 最后，发布服务器根据PUBMAP的内容自动 发布手册 。 * * * * 如果是公司员工自己需要翻阅用户手册，请在TSM搜索并下载地图， * * 对于公司重点项目，学院文档开发部会设立接口人，统一用户手册出口。必要时会派文档架构师、文档工程师到现场进行调研，开发文档。 * 2011年，在不少公司级重点项目中，用户手册都得到了客户的认可。包括像日本T1，德国KPN. * 这是日本T1项目的硬件安装手册，主要有三大特点。该手册得到日本用户的赞扬和肯定。 * 用户手册开