乐于分享
好东西不私藏

文档结构化解决方案

文档结构化解决方案

产品技术信息,是否存在如下困扰:

  • 难以找到正确的信息: 不同文档对同一内容的描述不同,客户抱怨不知道哪个才是正确的。

  • 信息过时,更新不及时: 变更不断发生,缺乏对内容有效性的管理,很难保证技术文档内容与产品技术状态一致。

  • 开发效率有待提高: 随着产品系列不断增多,参与写作的人多、写作的内容多、文档的发布量与日俱增。但是采用串行模式,多人写作协同程度低,一致性差。重用的内容采用拷贝&粘贴的方式,不仅工作量大,还容易出错。当原文档更改后,需要人工替换所有地方,更改工作量加倍。

  • 样式、规则不一致,品牌辨识度低

结构化写作,可完美解决这些问题!

什么是结构化文档?

结构化写作是一种创作和组织内容的方式,它的基本思想是根据预定义的规则来撰写模块化的内容,并且可以对内容模块进行多种方式的组织和重用。

结构化是将技术内容分类,然后分内容和场景去开发,这样可能会打通整个企业的各个部门,从研发到产品销售和售后服务,把整个产品生命周期所需要的技术信息都统一管理起来,让科技企业的运作达到高效与智能化。

通常意义上的结构化写作是通过XMLExtensible
Markup Language
)实现的,结构化写作的技术标准主要包括:

  1. DITA

Darwin Information Typing Architecture (DITA)OASIS发布的一套关于如何编写和发布技术信息的国际标准。DITA应用非常广泛,主要在民用领域,如制造业、出版、医疗、汽车、电子等。

  1. S1000D

S1000D是通用的技术出版物国际标准,主要用于航空、航天、军工等领域。

  1. Docbook

Docbook是一套面向书本的结构化标准,主要用于数字出版领域。

结构化文档的优势

  • 采用统一的编制标准,提升多人协同写作的一致性

  • 内容和样式分离,一次写作,多格式发布

  • 通过条件发布、变量等多种方式进行最大化重用和定制

  • 内容同源,一处更新,多处同步更新

总之,结构化文档就是更高效、更标准、更准确和更便捷。

基于HyperDoc的文档结构化解决方案

Etteplan 内容管理系统HyperDoc,与xml编辑器一起,高效实现结构化文档管理,能够按照用户的需要同源发布为PDF, HTML和其他形式资料交付件,实现多样化多媒体发布。

HyperDoc基于DITA标准,开发的内容一致性高,重用方便。同时还可以选择嵌入HperSTE  Simplified Technical English简明技术英语),在您为全球读者撰写内容时,一键提高您的技术英语可读性。

行业领导者都已经在使用结构化方式管理技术信息!

技术文档服务是Etteplan的核心的业务之一,集中了工程机械、医疗、电梯、车辆、非标自动化等领域的890位技术信息开发专家,通过本地和全球团队的合作,为全球超过100家企业提供技术信息相关服务。

Etteplan可提供丰富的技术信息开发服务:

  • 技术文档开发:如用户手册,维修服务信息等

  • 备品备件信息开发和维护

  • 文档/信息质量评估及改善

  • 非结构化信息的结构化转换

  • 培训和在线学习

  • 翻译和本地化

  • 信息开发、管理、流程等咨询服务