内容重用指南及典型场景分享,赶紧码住!
内容重用=内容复制吗?
在实际工作中,到底应该如何用好内容重用?
本期我们根据美嘉林首席顾问李琳老师发表的《DITA Reuse的6个典型场景》专题文章,结合美嘉林技术信息解决方案功能演示,帮助大家深度理解内容重用。
新的一年,享受高效工作带来的满满成就感!
内容重用,能避免重复编写、审核、翻译,也是保证内容一致性的必要手段。但重用并不是简单的拷贝粘贴,而是基于同源(Single Sourcing)的架构设计。
内容重用是“设计”出来的,不是“随机”发生的。
本文按照从整体到局部的思路分别介绍了4种维度的内容重用典型场景,供大家参考。
信息架构师可以基于业务规范,为不同类型手册定义架构模板,在新建手册时,选择所需模板创建手册,确保架构符合业务规范,也减轻人工校对的负担。
在开发产品手册的过程中,基于产品特性及文档规划,会有不同情况的内容重用需求,常见的典型场景如下:
场景1:同系列的多个产品型号,根据产品特性差异,部分内容会有差异。
例如,A系列产品,制作一个“A系列产品手册Map”,可以根据产品特性发布成《A10产品手册》、《A20产品手册》、《A30产品手册》等。
场景2:同一个产品,共用一套Topic,根据需要发布成多个不同用途的手册。
例如产品M100,制作一个“M100产品包技术文档Map”,发布成《M100技术规格指南》、《M100配置指南》、《M100使用指南》、《M100维护指南》等。
场景3:基于已有产品的技术文档修改为新产品的技术文档。
对于产品功能完全相同的部分,采用重用章节,对于内容有差异的部分,按需复制并替换内容,基于已有内容做调整。
例如,B系列产品和已有的A系列产品部分功能相同,可以基于已有A系列产品文档,快速编写B系列文档。
通过重用结构或内容,能保持2个系列产品的同步更新;通过复制引用差异内容,基于已有内容做调整。
系统提供以下能力,轻松支持上述不同的内容重用场景:
● 通过在大纲章节、Topic或Topic文档中设置适用性,区分内容差异,结合发布过滤动态生成与产品匹配的文档,提高内容的重用率
● 用拖拽的方式快速重用或复制引用手册结构和内容,直观高效
● 通过全文搜索定位并重用内容
在编写技术文档时,经常会遇到一些需要在多处保持一致的内容,例如维修工具、警示信息、专业术语、界面文本、扭矩值和技术参数等。通过定义和维护这些重用内容,并按需引用,可以实现统一管理和更新,从而确保数据的准确性和一致性。这样不仅提高了工作效率,还减少了因数据不一致而可能引发的错误。
针对不同的重用内容,系统还能提供汇总功能,例如可按章节汇总涉及的维修工具或扭矩,以帮助维修人员快速准备所需维修工具,快速查询维修过程中相关的扭矩。
在全球化的浪潮下,产品走向世界,多语言版本的需求日益增长,越来越多的内容团队希望实现以下场景:
场景1:在重用源语言内容的同时,自动重用翻译语言内容。
场景2:对于界面文本、术语、扭矩等特殊短语,可以通过维护多语言翻译字典根据业务要求设定它们的翻译文本,手册翻译时,系统会自动根据多语言文本替换,而无需外发翻译,以确保翻译内容的业务符合性,减少校对的难度。
上述内容重用的典型场景普适性高,管理容易,能实现事半功倍的效果,更可以提高内容质量。并已经过汽车、装备制造、电子高科等多个行业头部企业的验证。
若您想观看产品演示,扫码轻松获取视频资料。同时,美嘉林已开启体验通道,扫码即可便捷报名参与试用。试用名额有限,先到先得!👇👇👇
立即联系小美
申请产品试用
合作创新 成就价值
美嘉林时事热点,专业解读,最新产品资讯,24小时各平台滚动更新
热门产品及解决方案
行业解决方案
快速了解美嘉林
扫码关注
及时获取案例资讯
友情链接