软件公司公安与地理信息事业部产品审批工作规范

软件有限公司公安与地理信息事业部产品审批工作规范第一章总则第一条【编制目的】产品手册作为直接面向用户的软件产品使用说明，应具有基本的准确性、详尽性、易读性，以实现其真正的辅助指导作用。为提高产品手册的文档质量，统一和规范化产品手册类文档工作的过程管理，使产品手册生产线上的各部门负责人明确各部门职责范围并更好地协同工作，特制订本规范。第二条【适用范围】适用于对自主研发产品使用手册的文档编写、审核、批准等过程管理。第三条【规范性引用文件】本规范中所引用的相关规范及制度如下表：序号规范制度名称制订部门相关章节备注1《系列产品手册编写规范》研发中心产品管理部第六条【手册创建】2《软件配置管理规范》研发中心品质保证部第十九条【文档版本编制】34第四条【实施部门】产品管理部作为对自主研发产品的产品化过程监管部门，行使下列职权：（一）负责本规范的编写和更新维护工作；（二）负责产品使用手册文档的编写、审核、批注过程的跟踪监管及成果审核；（三）其它有关本规范的管理事项。第二章产品手册的编写更新第五条【基本流程图】产品手册主要包括产品的用户手册、二次开发手册以及系统部署说明书。产品手册的“编写、审核、批准”基本流程如下图所示：RDMSJ及SVNRDMSJ及SVN手册发布产品管理部手册修订测试验证研发中心手册编写、更新RDMS文件库共享Y产品服务部部署说明书完善产品用户手册、二次开发手册、部署说明书手册文档格式的转换处理产品管理部手册操作权限分配N测试部注：（一）“产品手册编写、更新”，主要包括产品的功能性用户手册、二次开发手册及系统部署说明书。（二）“RDMS文件库共享”，需由产品的项目经理为该产品项目组中的各成员分配文档操作权限，包括对产品手册文档的上传和下载；（三）“RDMS手册发布”，涉及产品手册的Word、PDF和CHM三种文档形式，其正式版本均由产品管理部统一管理。第六条【手册创建】产品手册文档一般由研发中心的产品研发负责人创建，其文档创建、编写工作需在产品的测试版本发布前完成。注：在对产品手册的文档创建及编写过程中，需依照产品管理部颁布的《系列产品手册编写规范》以及DOT模板进行，以实现产品手册文档名称、版面格式、内容架构等的统一、规范化。在产品研发负责人完成了产品手册编写后，需将其上传发布到该产品项目的RDMS“Future文件库”中，同时以RDMS系统邮件抄送的形式向各项目成员发出“创建”通知，并指定“文档审阅人”为产品管理部的产品专员。当产品及产品手册在RDMS中发布后，需由产品研发负责人为该产品项目的成员分配文档操作权限，包括对文件的上传、下载和更新。第七条【手册更新】当产品本身的功能模块发生新增、改进、删除等相关调整并有新的正式产品版本发布时，需要研发负责人对产品手册文档内容进行同步更新。此时，研发负责人需到RDMS文件库中重新下载获取该产品手册文档，然后在其基础上进行修改更新，并最终再发布到RDMS上提交修订，同时以RDMS系统邮件抄送的形式向各项目成员发出“更新”通知（此时的“文档审阅人”仍为产品专员），以保证产品手册内容的最新唯一性。第八条【关于“文档修订说明表】“文档修订说明表”是对产品手册修订过程中的一个文档辅助说明，要求在产品手册文档创建时即开始记录。该修订说明表将一般在产品手册文档的第二页给出，主要包括“手册版本号”、“对应的产品版本号”、“手册创建/修订人”、“手册审核人”、“修订日期”、“修订内容”等信息。每次在对产品手册的文档更新完成后，手册修订人员都要对各项内容进行填写，以实现对产品手册更新过程的跟踪记录，确保产品手册与产品版本的内容一致，便于后续工作开展。第三章手册的审核修订第九条【产品手册审核总述】产品手册的审核修订工作主要由产品管理部的产品专员来完成。在接收到RDMS系统的“产品手册创建/更新”通知或产品手册的“缺陷测试”报告后，对手册问题进行修订。具体如下：第十条【用户手册】在接收到RDMS系统的产品用户手册“创建/更新”通知后，产品管理部的产品专员即可通过RDMS“Future文件库”获取该文档。首先，产品专员需向品质保证组申请与该用户手册一致的产品版本，参考用户手册，以用户角度来认识产品和使用手册；然后，对用户手册中的文档结构、操作流程、语义描述、文档版面格式等进行全面补充和完善，最终使用户能够通过用户手册实现对整个产品功能应用的理解和掌握；修订后的产品手册，需重新上传发布到RDMS文件库对应的产品项目中，并指定“文档审阅人”为该产品的测试负责人，同时抄送给产品研发负责人、产品服务负责人及品质保证组。第十一条【二次开发手册】在接收到RDMS系统的产品二次开发手册“创建/更新”通知后，产品管理部的产品专员即可通过RDMS“Future文件库”获取该产品的手册文档。产品专员需要对二次开发手册文档中的产品概述、产品构成、语义描述、版面格式等进行修订，然后重新上传发布到RDMS的文件库中提交验证，即在上传文件时指定“文档审阅人”为测试部的该产品测试负责人，同时抄送给产品研发负责人、产品服务负责人及品质保证组。注：对于二次开发手册文档中的程序接口描述的准确性和合理性，产品管理部不予验证。产品专员在对测试人员反馈的问题过滤修订后，会将此部分问题直接交由产品研发负责人进行修正。第十二条【系统部署说明书】最初的系统部署流程文档（即“系统发布与部署说明文档”），一般是由产品研发负责人创建编写并随产品初始版本一起提交的。产品服务部在从品质保证组申请并获取到该产品安装文件的同时，即获得该文档。产品服务负责人需从“系统发布与部署说明文档”中提取出系统部署流程描述，并在其基础上进行补充完善，最终形成该产品的“系统部署说明书”。修改完善后的系统部署说明书，将被上传发布到RDMS“Future文件库”的对应产品项目中提交修订，即在上传文件时指定“文档审阅人”为产品管理部的产品专员。产品专员在接收到RDMS系统的产品部署说明书审阅通知后，对文档中的语义描述、版面格式等进行修订。修改后的产品部署说明书将再次被上传到RDMS文件库中提交验证，即在上传文件时指定“文档审阅人”为测试部的该产品测试负责人，同时抄送给产品研发负责人、产品服务负责人及品质保证组。第四章手册的测试验证第十三条【手册测试验证】在接收到RDMS系统的产品手册文档“审阅”通知后，产品测试负责人需通过RDMS“Future文件库”，获取该产品手册进行“文档测试”。产品测试负责人在对产品手册的测试过程中，需要比对产品手册内容与软件产品版本在模块构成、功能描述、操作过程等方面的一致性、准确性和完整性。此项工作即为“文档”与“产品”互相验证的一个产品测试过程。同时，需要将产品手册中存在的相关问题，以“测试报告”的形式反馈给产品管理部进行修订。在对产品手册中的问题修订并重新发布后，将重新提交给测试部对修改内容进行验证。最后，确定为“测试通过”的产品手册，需由产品测试负责人在RDMS的“审阅”栏中填写“审阅意见”为“通过”。产品管理部将测试通过的产品手册文档（PDF或CHM格式）更新到SVN库中，以便随产品版本一同发布。注：产品手册Word文档仅作为内部更新维护，随产品版本发布的产品手册文档需为PDF或CHM格式。第五章手册的过程维护第十四条【产品手册维护总述】为实现对产品手册文档的“同点发布”和“同点获取”，避免文档内容出现新旧交叉的混乱情况，需建立起一个统一的文档更新机制。产品手册的文档更新维护工作须遵照如下要求：第十五条【手册获取确认】在对产品手册文档进行更新修订前，文档修订负责人需向周边部门发出通知，确认RDMS中所发布的产品手册版本是否为最新，且当前是否有相关人员在对其进行修订。在确认RDMS手册版本为最新且无他人在维护后，文档修订负责人即可从RDMS的文件库中获取该手册文档进行更新修订。此项工作一定不容忽视，以保证在同一时刻对同一文档的更新维护只有一人在进行。第十六条【手册上传通知】文档修订负责人在对产品手册文档完成了更新修订后，即需将本次的文档修订说明与该产品手册一起，上传发布到RDMS文件库中。同时，要向周边部门发出文档更新通知，以供产品测试负责人对手册更新内容进行验证及后续更新。这样才能确保其它各部门的文档更新工作是在该后续环节的修改基础上进行，实现对各个阶段的工作成果予以积累和继承。第十七条【文档问题标识】在对产品手册的文档测试过程中，需要产品测试负责人以“修订”（“工具”菜单）或“批注”（“插入”菜单）的形式对文档中存在的问题进行标识，以便产品专员通过Word系统的“自动查找定位”功能对这些问题逐一处理，避免问题遗漏。第六章手册的版本管理第十八条【文档版本编制】在对产品手册的编写、更新过程中，产品手册的更新工作在很大程度上受制于产品版本的变更，需确保产品手册的版本与产品版本的对应管理。为保证产品手册版本与产品版本的对应一致，手册版本号需在手册的文档名称上予以标识体现。产品手册的文档名称基本格式统一为：‘产品项目编号’+下划线+‘产品全称’+‘产品版本号’+手册类别+下划线+‘手册版本号’+下划线+手册修订日期。产品项目编号：具体须以品质保证组颁布的“项目立项编号”列表为准。产品全称：包括产品英文简称以及中文名称。（具体须以产品管理部颁布的《产品名称公告》为准）产品版本号：要求与所对应产品的正式发布版本号保持更新一致，一般为V*.*.*（包括产品的主版本号、次版本号、修订版本号）。（具体请参见《软件配置管理规范》的“3.4.4.2代码类版本标识”章节）手册类别：包括产品的用户手册、二次开发手册或部署说明书等。手册版本号：V*.*。（具体请参见《软件配置管理规范》的“3.4.4.1文档类版本标识”章节）。手册修订日期：由文档修订人员给出，基本格式为“YYMMDD”。第十九条【文档版本编制】除对产品手册文档名称的标识外，要求文档修订人员在手册文档第二页的“文档修订说明表”中，注明产品手册所对应产品的具体版本（包括主版本号、次版本号、修订版本号和测试版本号）。另外，在“文档修订说明表”的“备注”项中，可查看到该产品手册所对应的具体产品版本号，如“该手册所对应的产品版本号为EzSpatialV3.0.6.1_090305”。注：关于“产品版本号”以及“文档版本号”的具体管理办法，请参见品质保证组颁布的《软件配置管理规范》。第七章手册的正式发布第二十条【文档格式转换】在对Word文档形式的产品手册评审通过后，还需将其进行文档格式转换。具体分为两种情况：一是作为独立文档提供时，需要转换为经过“不可复制”、“不可打印”等加密处理的PDF文档形式；二是在产品中以“帮助文档”的形式被直接调用时，需要根据系统的文档格式要求将其转换为加密PDF文档或CHM文档。产品手册的文档格式转换工作，由产品管理部的产品专员完成。转换处理后的PDF或CHM形式的产品手册，仍需通过RDMS发布并提交给产品测试负责人进行测试。注：Word文档形式的产品手册，在转换为PDF格式前，需将第二页的“文档修订说明表”删除；在转换为CHM格式前，需将“文档修订说明表”和目录页均删除。最后，确定为“测试通过”的PDF或CHM格式产品手册，需要产品测试负责人在RDMS中填写“审阅结论”为“通过”。第二十一