一种用户手册生成方法及系统技术方案

本发明专利技术公开了一种用户手册生成方法及系统，包括：确定需生成的用户手册的产品；建立用于所述产品的信息交互平台；与所述产品相关的人员通过所述信息交互平台提供与所述产品相关的信息；采集所述信息交互平台上与所述产品相关的信息来生成用户手册。本发明专利技术提出了一种用户手册的自动化生成机制，使得编写用户手册不再需要的耗费专门的人力，能够保证用户手册生成系统能够实时更新，支持用户手册的在线查看和离线用户手册的自动化生成，大大提高了用户手册生成系统的生成效率和产品性能。

【技术实现步骤摘要】

本专利技术涉及数据处理技术，特别涉及一种用户手册生成方法及系统。
技术介绍
目前还没有针对于各种软硬件产品及系统的通用的用户手册生成方案。常规的 用户手册编写往往是在软件编写完成时，由专人编写出word形式的用户手册，如果需要则 再利用help workshop将word文档整理成chm格式的文档。其中，WORD是OFFICE家族的 成员之一，它的主要功能是编辑文字，WORD格式是Office Word编辑的文本文件，扩展名 为.doc ；chm文件格式是微软1998年推出的基于HTML(HyperiText Markup Language,超 文本标记语言)文件特性的帮助文件系统，以替代早先的WinHelp帮助系统，在WindoWS98 中把CHM类型文件称作"已编译的HTML帮助文件"。被IE浏览器支持的Jav必cript、 VBScript, ActiveX、JavaApplet. Flash、常见图形文件(GIF、JPEG、PNG)、音频视频文件 (MIDI,WAV,AVI)等等，chm 同样支持，并可以通过 URL(Uniform Resource Locator，统一资 源定位符)与hternet(因特网)联系在一起。传统的用户手册编写方式有着很大的缺陷。首先，由于这种文档由专人编写，这对编写用户手册对人的要求一般比较高，他需 要对产品的方方面面都要有一定的了解。实际情况下，这种人是不存在的。而如果为了写 用户手册，专门对整个系统进行重新熟悉和学习，代价又比较高。其次，由于在这种用户手册编写模式下，用户手册往往是在产品开发完成之后推 出之前编写，而且在推出之后不会更新，这种情况下，用户手册完全是从开发者的角度来编 写，不一定能达到很好的效果。最后，产品往往是一种周期性更新的产品，往往处于频繁地变化过程中，这种情况 下，原先编写的用户手册很容易过期、不再适用。因此，这种用户手册编写模式是很不科学 的，不仅付出的代价很高，进度要求很紧，有时甚至是不可能实现的。这也是以往用户手册 的生成系统一直做得不好的原因。
技术实现思路
本专利技术所解决的技术问题在于提供了一种用户手册生成方法及系统。本专利技术实施例中提供了一种用户手册生成方法，包括如下步骤确定需生成的用户手册的产品；建立用于所述产品的信息交互平台；与所述产品相关的人员通过所述信息交互平台提供与所述产品相关的信息；采集所述信息交互平台上与所述产品相关的信息来生成用户手册。较佳地，建立用于所述产品的信息交互平台时，基于维基技术建立以文章为中心 的架构体系。较佳地，进一步包括为不同的与所述产品相关的人员设定不同的访问权限。较佳地，采集所述信息交互平台上与所述产品相关的信息来生成用户手册，包 括遍历所述信息平台上存在的与所述产品相关的信息；以所述信息平台上的page表名为用户手册的标题名；以在所述信息平台上联合查找所找到的text表中的内容为用户手册的内容主 体；按标题名与相应的内容匹配后生成离线HTML文件，并将其作为用户手册的基本 材料。较佳地，进一步包括生成离线HTML文件后，对HTML文件中的对文件超链接信息重新进行定位。较佳地，生成离线HTML文件后，进一步包括采用chm格式、word格式或pdf格式的文档作为用户手册的形式。较佳地，采用chm格式的文档作为用户手册的形式，包括采用XML文件作为HTML文件生成chm文件的中间体。本专利技术实施例中提供了一种用户手册生成系统，包括信息交互平台，用于为与产品相关的人员提供与产品相关的信息，所述信息交互 平台是在确定需生成的用户手册的产品后建立的用于所述产品的信息交互平台；生成模块，用于采集所述信息交互平台上与所述产品相关的信息来生成用户手 ππ册。较佳地，信息交互平台进一步用于基于维基技术建立以文章为中心的架构体系。较佳地，进一步包括管理模块，用于为不同的与所述产品相关的人员设定不同的访问权限。较佳地，生成模块包括遍历单元，用于遍历所述信息平台上存在的与所述产品相关的信息；标题生成单元，用于以所述信息平台上的page表名为用户手册的标题名；内容生成单元，用于以在所述信息平台上联合查找所找到的text表中的内容为 用户手册的内容主体；手册生成单元，用于按标题名与相应的内容匹配后生成离线HTML文件，并将其作 为用户手册的基本材料。较佳地，手册生成单元进一步用于在生成离线HTML文件后，对HTML文件中的对文 件超链接信息重新进行定位。较佳地，手册生成单元进一步用于在生成离线HTML文件后，采用chm格式、word格 式或pdf格式的文档作为用户手册的形式。较佳地，手册生成单元进一步用于在采用chm格式的文档作为用户手册的形式 时,采用XML(extensible Markup Language，可扩展标记语言)文件作为HTML文件生成chm 文件的中间体。本专利技术有益效果如下在本专利技术实施例提供的技术方案中，由于在确定需生成的用户手册的产品后，便建立用于所述产品的信息交互平台；使得与产品相关的人员可以通过该信息交互平台提供 与所述产品相关的信息；从而能够采集信息交互平台上与所述产品相关的信息来生成用户 手册。由于与产品相关的人员都可以通过信息交互平台来提供与产品相关的信息，也就 是说，软件的用户手册不仅仅由产品开发者完成，产品测试者、用户也都可以参与到这个用 户手册生成系统的信息更新过程中，从而保证了用户手册所提供的信息实时而且有效。进一步的，在建立用于所述产品的信息交互平台时，是基于维基WiKi平台的架构 建立的，由于采用定制过的维基平台作为信息存储体，因此，信息存储体中存储的信息能够 不断地更新。进一步的，由于采用了 XML文件作为HTML文件生成chm文件的中间体，创造性地 使用XML形式的文件存储组织信息，因此，实现了用户手册信息存储体中信息自动化导出 的过程。能够根据信息交互平台提供的信息，自动化生成各种离线的信息文档和这些信息 文档的组织信息。进一步的，在用户手册的自动化生成时，由于可以利用导出离线信息文档和这些 信息文档的XML格式的组织信息，因此可以将这些信息组织成完整的chm格式的文档。进一步的，由于以所述信息平台上的page表名为用户手册的标题名；以在所述信 息平台上联合查找所找到的text表中的内容为用户手册的内容主体；并按标题名与相应 的内容匹配后生成离线HTML文件，并将其作为用户手册。因此，生成的离线文档具备清晰 的目录、索引等组织结构，并且能够支持全文搜索功能。由上述实施例可见，本专利技术实施例中提供的技术方案提出了一种用户手册的自动 化生成机制，使得编写用户手册不再需要的耗费专门的人力，能够保证用户手册生成系统 能够实时更新，支持用户手册的在线查看和离线用户手册的自动化生成，大大提高了用户 手册生成系统的生成效率和产品性能。附图说明图1为本专利技术实施例中用户手册生成方法实施流程示意图；图2为本专利技术实施例中信息交互平台示意图；图3为本专利技术实施例中转换过程示意图；图4为本专利技术实施例中用户手册生成的使用实施流程示意图；图5为本专利技术实施例中用户手册生成系统结构示意图。具体实施例方式在专利技术过程中，专利技术人注意到用户手册生成系统的设计的目标主要在克服几大 缺点，并且最大限度的节省劳动力本文档来自技高网...

【技术保护点】
一种用户手册生成方法，其特征在于，包括如下步骤：确定需生成的用户手册的产品；建立用于所述产品的信息交互平台；与所述产品相关的人员通过所述信息交互平台提供与所述产品相关的信息；采集所述信息交互平台上与所述产品相关的信息来生成用户手册。

【技术特征摘要】

【专利技术属性】
技术研发人员：杨骥，郝玉杰，范炬，牟建斌，徐黎，冯华宇，崔代锐，彭强，靳雅群，
申请(专利权)人：大唐移动通信设备有限公司，
类型：发明
国别省市：11