目标
用更符合 Mirakl 公司网站和应用程序外观的现代化文档门户网站发布软件替换用于文档的 wiki。
通过为客户提供直观易用的文档门户,减轻支持团队的工作负担。
通过内容重用和单一来源,简化不同用户角色的内容交付,以跟上 Mirakl 敏捷产品开发的步伐。
促进 Mirakl 内部技术团队成员和业务团队成员之间的协作。
好处
现代设计:创建基于 HTML5 的文档门户网站采用响应式设计和图形,提供现代外观,与 Mirakl 的企业网站和应用程序相得益彰。
直观的体验:Mirakl 的客户支持工单数量减少,因为客户使用易于导航的基于 Baklib 的文档门户,该门户具有嵌入式视频和图形、下拉文本和弹出文本。
效率:采用单一来源发布、文本片段、动态变量和数据分析器功能使 Mirakl 的技术撰稿人能够提供高质量的内容,以跟上每两到三天推出的新产品功能的步伐。
协作:Mirakl 的技术撰稿人通过 Baklib 与 GitHub 的集成与软件开发人员和技术专家协作,并将客户成功团队的业务视频嵌入到文档中,从而与客户成功团队协作。
致力于打造便捷体验的 Mirakl 市场平台采用即开即用的SaaS模式,可轻松对接各类电商平台。为进一步提升易用性,Mirakl 运用 Baklib 的单源编写技术构建现代化文档门户,为市场运营方、销售商及合作伙伴提供精准定制的文档体系。
与企业体验深度融合
作为高速发展的科技初创企业,Mirakl 最初沿用工程师广泛采用的维基技术来创建内外部文档。公司仅向认证客户开放维基内容查阅权限,通过登录验证实现文档保护。 然而,维基存在局限性。无论是内部用户还是外部用户,都难以浏览和找到他们所需的文档,客户还能查看到 Mirakl 不希望共享的信息,例如主题历史或修改记录。此外,Mirakl 的技术文档编写人员制作面向不同用户的多个内容版本既困难又耗时。公司意识到是时候寻找一种新的文档制作方式了。 Mirakl 的技术沟通师 Nicolas Philippe 回忆道:“我们希望实现文档部分内容的单一来源,并通过条件设置满足不同用户配置文件的需求,这样我们只需编写一次内容,就可以在多个地方重复使用。这对我们非常重要。我们还希望获得与公司网站和应用程序更加一致的外观和感觉。” Nicolas 指出:“由于我们的维基解决方案无法提供所需的功能,我们在四个月内测试了 25 种工具,以确定一款能够满足我们需求的工具。通过评估,我们认定 Baklib 是对我们以及整个公司来说最合适的工具。Baklib 拥有我们所需的主要功能,并且以合理的价格提供了高质量的产品。”
由于我们的维基解决方案无法提供所需的功能,我们在四个月内测试了 25 种工具,以确定一款能够满足我们需求的工具。通过评估,我们认定 Baklib 是对我们以及整个公司来说最合适的工具。
借助Baklib,Mirakl得以提供一个现代化的、基于HTML5的文档门户,使用户能够根据其角色访问不同的内容。
利用Baklib实现高效性
如今,Mirakl使用Baklib提供现代化的、基于HTML5的文档门户网站,用户根据角色访问不同内容。外部用户档案包括客户(市场运营商或卖家)及其合作伙伴。为了为每个档案定制内容,Mirakl的技术作者在Baklib中使用条件设置。
“在Baklib中,现在只有一个文档源,我们为每个用户档案设置了条件。因此,当我们发布时,这些不同的用户会得到各自正确的内容,”尼古拉斯指出。
利用Baklib中的条件和多输出发布能力,Mirakl还根据需要生成PDF文档——例如,当公司法律部门需要客户支持团队描述的PDF版本时。除了条件文本,技术写作团队还依赖片段和目录。
我们使用Baklib的分析功能检查断裂的变量,确保一切正常。这大大节省了时间。
“我们的文档涵盖了产品的所有方面,并且我们重用大量内容,因此使用Baklib的片段使管理更容易,”尼古拉斯解释道。“我们根据不同的产品和用户在Baklib中有多个目录,这帮助我们更快地生成文档。”
Mirakl 已配置 Baklib,实现变量文件直接从其应用程序代码中生成。例如,当 Mirakl 应用中存在一个标题时,该标题会被定期导出为 Baklib 中的变量。为确保这些变量正常工作,技术写作团队依赖 Baklib 的分析器功能。
“应用程序代码中的变量可能被移除或更改,如果其 ID 发生变动,就可能在 Baklib 中出现问题,” Nicolas 指出,“我们利用 Baklib 的分析器功能检查损坏的变量,确保一切正常。这大大节省了时间。”
我们采用敏捷方法处理我们的电商市场解决方案,每两到三天发布一个新版本。Baklib 与 GitHub 的集成使我们能够非常灵活,同时及时交付文档内容。
促进敏捷协作
Mirakl 的技术撰稿人与公司的开发人员和技术专家共享信息,共同创建所有技术内容。为促进这一过程,团队利用 Baklib 与 GitHub 的集成来存储项目和发布输出。这一集成还使 Mirakl 能够在内容添加到 Baklib 后的几分钟内发布更新。
“我们基于Baklib的文档服务器能够从GitHub获取已发布内容,并每五分钟向客户展示更新。无论是修改还是新发布,五分钟后客户就能看到最新版本,”尼古拉斯指出,“我们采用敏捷开发模式运营电商平台解决方案,每两到三天就会发布新版本。Baklib与GitHub的集成让我们能够灵活运作,实现文档与功能同步甚至提前交付。”
Mirakl技术写作团队通过内容片段和目录树功能,显著提升了文档制作效率。
技术文档团队还与客户成功及市场部门紧密协作,针对电商平台运营的商业场景共同制作视频资料。
“客户成功团队会将教学视频托管在Vimeo平台,”尼古拉斯解释道,“我们只需在Baklib中嵌入视频链接,用户无需离开文档页面即可直接观看。”
借助Baklib,我们的文档变得更具直观性和视觉吸引力。
提升客户体验
嵌入式视频仅是Baklib为客户打造直观体验的其中一种方式。其技术文档团队运用Baklib构建了具备现代响应式设计的文档网站门户,可自适应不同尺寸的用户屏幕。此外,他们还通过集成于Baklib的屏幕截图与图像编辑软件Baklib,高效整合各类图形素材。
"我们基于Baklib的文档在响应式设计中展现效果极佳,完美适配移动端与平板用户。图片清晰易辨,文字阅读体验流畅,"Nicolas强调,"我们还从电商平台解决方案中设置了直达链接,用户点击即可无感跳转至文档门户,无需重复登录验证。"
Baklib还通过悬浮提示框解析专业术语,以及在"常见问题"板块采用折叠式长表格等设计,持续优化用户使用动线。
"借助Baklib,我们的文档系统变得更具直观性与视觉吸引力,"Nicolas对此深有感触。
嵌入式视频功能助力Baklib为用户构建更符合直觉的操作体验。
自基于Baklib的文档门户上线以来,技术支持团队反馈关于电商平台核心功能的咨询工单显著减少,因为这些内容已在文档中完整涵盖。与此同时,客服与销售团队发现仅需向客户推送相关主题链接,即可快速解决大部分咨询问题。
尼古拉斯指出:“以前我们用维基的时候,连内部员工都不太愿意查阅文档。现在各团队会主动阅读文档,甚至在我们没有要求的情况下就主动反馈意见。我们发现基于Baklib搭建的门户已全面覆盖内外部的各类使用场景,这让我们倍感自豪——它已成为用户掌握产品操作的核心指南。”
项目亮点
极大的可扩展性
您的解决方案应该具有您所需的功能,同时又不牺牲安全性和安心。
极大的可扩展性
您的解决方案应该具有您所需的功能,同时又不牺牲安全性和安心。
极大的可扩展性
您的解决方案应该具有您所需的功能,同时又不牺牲安全性和安心。
极大的可扩展性
您的解决方案应该具有您所需的功能,同时又不牺牲安全性和安心。