Baklib-功能聚焦解释版本控制

版本控制是管理文档的不同草稿和版本的过程。它提供了用于修改和更新这些最终版本的审核跟踪。

我们开始这个功能聚焦系列是为了让您更好地了解我们的功能。 Baklib 的设计和开发基于我们 5 年多来为我们成功的企业产品BizTalk360 、 Atomic Scope和Serverless360构建文档的痛点。

我们之前的文档解决方案的主要问题之一是缺乏版本控制功能。敏捷几乎是当今默认的操作模式,大多数软件公司更喜欢快速且频繁地发布版本。主要的发布后活动是更新文档,这可能是一项乏味的任务并且经常被遗忘。

文章级版本控制(修订)

对于经过多次修订的文档来说,版本控制是一项重要功能,尤其是当多个用户处理同一个文档时。这些文章很容易出现人为错误,版本控制有助于将文档恢复到健康状态。挑战在于比较两个版本并找出差异。

要(编辑文章)或创建现有文章的版本,您需要分叉已发布的文章。

当您分叉已发布的版本时,这将自动创建同一篇文章的第二个版本(版本 2)。在这种情况下,当前版本将为 v2,发布版本将为 v1。

一旦您发布文章的编辑版本,发布的版本将更改为 v2。

Baklib 还具有丰富的差异查看器功能,可以在左侧显示旧版本内容,在右侧显示较新版本内容。差异将以红色和绿色突出显示。 (红色表示已删除的内容;绿色表示新添加的内容)。它还提供不同的视图,例如代码差异和渲染差异来查看差异。

下面的示例显示差异查看器如何显示两个文章版本之间的差异。您还可以注意到,我们不是在比较两个相邻的版本,而是在比较两个单独的版本(版本 1 和版本 3)。

项目级版本控制

举个例子,假设产品的当前版本是 v1.0,在下一个版本中,将对v1.0 进行重大修改,并向产品添加新功能。由于v1.0更改贯穿整个项目,因此产品文档中的大部分屏幕截图都会发生变化。

在这种情况下,不太可能更改 v1.0 文档,因为现有客户将使用该产品的 v1.0。理想的做法是创建新版本的文档(例如 v2.0)并处理新产品版本的更改。

默认情况下,当在 Baklib 中创建项目时,版本号为“v1”,标记为主版本并设为公共版本。在“设置”->“版本”中,您可以选择创建新版本并为其提供一个友好的名称。

您需要指定哪个将是您将分叉(制作副本)的基本版本

创建项目后,您会注意到有不同的配置选项可用,例如 –

配置描述
主版本将新创建的版本设置为主版本
是测试版如果您的文档特定于 Beta 版本,请启用此选项
是公开的如果您的客户应公开查看您的文档,请启用此选项
已弃用启用此选项可将您的文档标记为已弃用(特定于不再支持的任何旧版本产品)。

因此,使用Baklib ,您可以在发布后轻松地使用新功能和屏幕截图更新所有文档(维护不同的版本)或跟踪人们正在使用的不同版本。

  • 2
    点赞
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值