MadCap客户成功案例：Cognex Corporation

Cognex 是世界领先的机器视觉供应商，改用 MadCap 软件以提供可搜索的知识库、八种语言的多个 PDF 指南和现代文档网站

 

 

目标

• 减少翻译和本地化产品文档的成本。
• 促进内容重用，缩短项目时间，同时向多个渠道发布。
• 通过现代网站实现对信息的简单、直观的访问。
• 确保多种产出的一致性和合规性。

解决方案

• MadCap Flare 原生 XML 单源、多渠道内容创作软件
• MadCap Lingo高级计算机辅助翻译管理软件

好处

• Cognex 拥有使用 MadCap Lingo 的翻译记忆库的能力，加上 MadCap Flare 中单一来源内容的效率，使其能够在 4 年内将本地化成本降低 68%。
• MadCap Flare 中基于主题的创作、单源发布、片段、变量和条件帮助将新文档的开发减少了 50% 以上。
• MadCap Flare 提供的响应式设计、顶部和侧面导航以及可自定义的皮肤使Cognex能够提供具有企业网站外观的直观文档和知识库网站。
• MadCap Flare 中的全球项目链接有助于正确使用徽标和其他 Cognex 公司资产，并确保符合行业和政府的要求。

 

Cognex利用MadCap Lingo拥有其翻译记忆的能力，加上MadCap Flare中单一来源内容的效率，使其在4年内削减了68%的本地化成本。

MadCap Flare中基于主题的创作、单一来源的发布、片段、变量和条件，有助于将新文档的开发时间缩短50%以上。

MadCap Flare提供的响应式设计、顶部和侧面导航以及可定制的皮肤使Cognex能够提供直观的文档和知识库网站，并具有企业网站的外观和感觉。

MadCap Flare中的全球项目链接有助于正确使用标识和其他Cognex公司资产，并确保符合行业和政府的规定。

 

在世界各地的工厂、仓库和配送中心，客户使用Cognex产品来帮助检测缺陷、监控生产线、引导装配机器人以及跟踪、分类和识别零件。 今天，Cognex提供了一个现代文档网站，其中包含其文档的 HTML5 和 PDF 版本、多达 8 种语言的本地化文档以及一个交互式知识库网站，以帮助客户正确使用这些关键任务产品。 为了简化这些信息的开发、本地化和交付，Cognex依靠 MadCap Flare 进行单源发布，依靠 MadCap Lingo 进行内部翻译和本地化。

 

重复的文档增加了本地化成本

多年来，Cognex依靠多种文档工具组合：Adobe® RoboHelp® 生成软件帮助文件，Microsoft® Word、Adobe® InDesign 和 Adobe® FrameMaker® 为客户发布多种语言的 PDF 文档。 此外，FrameMaker® 需要针对内部翻译人员的特定语言许可证和操作系统。

“通常，如果需要更新信息，作者必须在多个文档中进行更改并手动跟踪所有更改，”Cognex公司的首席技术作者 Kellie Freeman 回忆道。 “然后，当向本地化供应商提交内容时，整个 FrameMaker® 图书文件或 Word 文档都必须重新翻译，这非常昂贵。”

为了简化本地化工作，Cognex团队开始调查 MadCap Flare。 2010 年，该公司开始将其旗舰 In-Sight® 产品线的文档迁移到新的单一来源发布软件。

 

简化发布到多个渠道

Cognex继续扩大对 MadCap Flare 的使用——从维护其 In-Sight 文档，到从 2014 年开始将所有 Cognex 技术文档迁移到 Flare，在 2014 年推出知识库网站，以及最近在 2019。

在其文档的整个演变过程中，MadCap Flare 的关键功能促进了内容的重用，并帮助技术编写团队更快地完成了项目：

• 切换到模块化、基于主题的创作使团队能够为各种文档和输出类型重用相同的主题。
• 片段允许作者进行一次更改以更新文档的所有适用区域。

 

 

• 作者大量使用条件从相同的源内容创建许多不同的文档。
• 通过使用交叉引用，团队消除了依赖超链接时可能出现的过时引用的风险。
• 作者还广泛使用变量来单一来源文档，利用 MadCap Flare 的灵活性为特定目标覆盖它们。
• 样式表介质允许团队从单个级联样式表 (CSS) 生成所有 PDF 和响应式 HTML5 输出，该样式表通过全局项目链接在所有文档项目之间共享。

 

过去，为新产品创建文档可能需要几个月的时间。 现在，借助 Flare，我可以利用现有内容并在短短两到四个星期内生成新文档。

 

凯莉·弗里曼 | Cognex公司首席技术作家

“我们非常依赖 Flare 的所有单一来源功能。 在制作新产品文档时，它为我们节省的时间是无法估量的，”Kellie 指出。 “过去，为新产品创建文档可能需要几个月的时间。 现在，借助 Flare，我可以在短短两到四个星期内利用现有内容并生成新文档。”

通过全球项目链接实现合规性

MadCap Flare 最关键的功能之一是全球项目链接，它使 Cognex 团队能够确保输出的一致性和合规性。

全球项目链接是单一采购的缩影。 它使我们能够从一个位置控制所有文档的外观，立即将更改集成到所有 Flare 项目中，并使用我们的持续集成构建系统自动发布更新，而无需编写人员进行任何手动工作，”... “这为我们节省了很多时间。

--凯莉·弗里曼 | Cognex公司首席技术作

“全球项目链接是单一采购的缩影。 它使我们能够从一个位置控制所有文档的外观，立即将更改集成到所有 Flare 项目中，并使用我们的持续集成构建系统自动发布更新，而无需编写人员进行任何手动工作，”Kellie 说。 “这为我们节省了很多时间。”

在Cognex，合规性不仅适用于企业品牌，还适用于行业和政府标准。 例如，要将硬件产品运往韩国，Cognex必须获得韩国认证并在其硬件文档中发布“KCC”标志。

“我们必须为不同的合规标准包含特定的文本和徽标，”Kellie 指出。 “通过全球项目链接，可以在所有文档中使用单个徽标，从而确保所有产品文档都符合最新标准。 手动复制和粘贴永远不会有差异风险。 这对我们来说意义重大。”

使用 MadCap Lingo 控制翻译成本

MadCap Flare 的单一来源出版使Cognex仅在前六个月就将必须翻译的字数减少了 39%。 2010 年，Cognex还开始使用与 MadCap Flare 紧密集成的 MadCap Lingo 来简化内部翻译。

 

 

但是，该公司的翻译记忆库仍由供应商保管。 这种认识促使 Cognex 团队使用 MadCap Lingo 将其翻译记忆库引入内部。

“使用 MadCap Lingo，我们获得了对所有翻译记忆库资产的控制权，”Kellie 回忆道。 “这让我们可以灵活地在短时间内切换到不同的供应商； 我们只是为他们提供我们的翻译记忆库来实现这一转变。”

Cognex通过 MadCap Lingo 翻译记忆库和 MadCap Flare 单一来源减少了与本地化文档相关的时间和成本，这使得该公司在提交内容进行本地化时能够增加 100% 匹配的数量。 这减少了内部翻译人员的工作，并允许 Cognex 团队与本地化供应商进行谈判，因此他们只对新翻译收费，而不对 100% 匹配收费。

根据内部翻译人员的反馈，使用 MadCap Lingo 将翻译时间从两到三周减少到大约两天。 同时，MadCap Flare 中的模块化主题和片段允许我们只发送新的或修改过的内容进行翻译。 仅在头四年，我们就将 In-Sight 产品线的本地化成本降低了 68%。

--凯莉·弗里曼 | Cognex公司首席技术作家

多种语言和格式的 PDF 文档

利用 MadCap Flare 和 MadCap Lingo，Cognex现在为文档网站上提供的 47 个产品版本中的每个版本托管大约 78 个 PDF，包括不同的语言版本。不仅有特定语言的用户手册和各种快速参考指南；该公司还制作多语言文档，例如，包括英语、日语、中文、韩语、法语、德语、西班牙语和葡萄牙语的规范。

此外，该团队还使用 MadCap Flare 的页面布局、全局项目链接和单源发布功能为其各种 PDF 输出创建不同大小的页面布局。

“Flare 中的页面布局功能与全球项目链接相结合，非常棒，”Kellie 说。 “我们的全球项目中有页面布局，这些页面布局配置了封面标题和产品照片的占位符。在本地项目中，作者只需输入标题和特定产品照片即可创建与企业品牌一致的定制版本。”

Cognex文档的产品照片由企业营销部门提供。但是，技术编写团队也使用 SolidWorks Composer 计算机辅助设计 (CAD) 软件生成图形。然后将图形作为高质量 PNG 文件导入到基于 MadCap Flare 的文档中。

 

 

“在 Flare 中使用 SolidWorks Composer 图形使我们能够自定义提供给客户的安装图形。 这使客户更容易让他们的产品更快地启动和运行，”Kellie 解释说。

创建易于搜索的知识库

除了提供产品文档外，Cognex还维护一个知识库，其中发布了技术支持团队收到的常见问题以及答案。 该知识库最初是使用遗留工具创建的，搜索和导航有限，并且无法抓取。 2014 年，这些限制导致 Cognex 团队使用 MadCap Flare 推出了一个新的现代知识库。

作为一个基于 HTML5 的网站，知识库可以很容易地被搜索引擎抓取。 此外，Cognex团队对所有内容进行了彻底检查以提供一致的术语和消息传递，并且他们添加了特定于产品的搜索过滤器。

使用 Flare，我们能够为客户提供易于浏览的知识库，帮助他们快速找到常见问题的答案。 在我们的第一年，我们看到页面浏览量比原始知识库网站增加了 41%。

--凯莉·弗里曼 | Cognex公司首席技术作家

由于许多 Cognex 客户都在制造，他们可能需要使用他们的移动设备从工厂车间访问知识库。最初，该团队使用单独的桌面和移动网站提供知识库，这得益于 MadCap Flare 对移动输出的早期支持。最近，Cognex利用 MadCap Flare 中的响应式设计功能将知识库作为单个现代网站提供，该网站可根据客户屏幕自动调整用户界面。

“有了 Flare 的响应式 HTML5，我们的知识库有了一个单一的站点，让客户可以从任何设备上找到他们需要的答案，”Kellie 解释说。

最近的其他增强功能正在从顶部导航转向侧面导航，并更新网站以与公司网站 Cognex.com 的变化保持一致。

“Flare 使知识库站点的维护和更新变得非常容易，”Kellie 指出。 “制作更新的外观原型、获得营销批准并完成实施大约需要一个月的时间。”

建立现代文档网站

多年来，Cognex主要将其基于 MadCap Flare 的文档作为随其软件安装的 PDF 和 HTML5 输出提供。公司网站上提供了一些文档，如 PDF、Word 文档和 Zip 文件，但必须手动上传。

“如果我们的客户没有安装软件，就很难找到他们需要的信息，因此在 2018 年，我们决定创建一个新的文档站点，”Kellie 回忆道。

Cognex 的技术作者与全球营销团队合作，使用 MadCap Flare 构建了一个响应式文档网站，该网站于 2019 年 9 月推出。今天，该网站为其当前 47 个产品版本中的每一个都托管了大约 51 个响应式 HTML5 输出和 78 个 PDF，以及作为这些产品早期版本的文档。

“我们有数百个输出。使用持续集成和 MadCap Flare 命令行构建，我们可以自动生成所有文档，”Kellie 解释说。 “这使我们能够持续提供任何必要的更新并跟上产品发布的步伐。”

为了复制公司网站的外观和感觉，Cognex团队使用 MadCap Flare 创建了一个 HTML5 皮肤和级联样式表 (CSS)。 这与徽标、产品图像和其他公司内容一起在全球项目中进行管理。 然后，通过全局链接，将任何更改推送到所有相关输出。

Flare 使我们可以轻松地与公司网站的外观完全匹配。 通过在单个位置而不是数百个单独项目中进行更改来自动维护企业品牌的能力是非常宝贵的。

--凯莉·弗里曼 | Cognex公司首席技术作家

 

 

为客户提供无缝网络体验

对于用户来说，文档网站只是公司网站的一部分。在支持页面上，客户可以选择一个产品系列，然后单击“文档”。从产品文档页面，只需单击相应的图标即可访问 HTML5 或 PDF 版本的文档。此外，任何可用的翻译文档都会根据客户指定的区域设置自动显示。

公司网站还为客户提供创建“MyCognex”帐户并注册其产品的选项。最近，此功能得到了扩展，因此当客户登录其帐户时，他们无需额外导航即可访问其产品的个性化文档。

“用户的整体体验更加直观，”Kellie 指出。 “从漂亮的现代文档网站到本地化的内容和直观的知识库，MadCap Software 帮助我们为我们的客户创造了吸引人的一流体验。”