文档团队怎样使用GIT做版本管理
创始人
2024-06-01 12:48:27
0

有不少小型文档团队想转结构化写作和发布,但是因为有限的IT技能和IT资源而受阻。本文为这样的小型文档团队而准备,描述怎样使用Git做内容的版本管理。


- 1 -

为什么需要版本管理

当一个团队进行协同创作内容时,有以下需要:

  • 在对文档做新版本的修订时,希望获得老版本的内容做修改并发布

  • 当对内容做修改后,想回到修改前的状态

  • 当团队成员共同修改内容时,希望避免彼此覆盖对方的修改

  • 需要获得同一个文件的两个版本,对比查看有什么改动

  • 防止内容因磁盘损坏等原因而丢失

版本管理软件就是为解决以上问题而设计。 

Git是一个开源的分布式版本控制系统,可以有效、高速地处理从很小到非常大的项目版本管理。它最初是为管理软件代码而设计,现在很多的文档采用DITA、Markdown等纯文本格式来编写,Git也适合用于对文档进行版本管理。

- 2 -

版本修订过程

下边是文档团队使用Git来做内容编辑和发布的过程。我们用Gitee和Github desktop来说明。 

注:这里描述的不是唯一的方法,它是一种相对简单的做法。 

1. 创建仓库

在浏览器中注册用户并登录www.gitee.com,可以通过以下步骤创建内容仓库:

2. 增加内容

首先,使用Git客户端软件(Github Desktop)在个人电脑上将Gitee上的内容仓库克隆(Clone)到本地,这个操作只需要做一次。

 上图的Repository URL填写Gitee上创建的仓库URL,从下图处获取:

内容放在本地磁盘的C:\dev\dyson目录,目前目录中无内容。

然后,我们添加内容。

比如:在C:\dev\dyson目录中创建topics和graphics子目录,然后将手册的图放到graphics目录中,将DITA Topic文件放到topics目录中,ditamap文件则直接放在C:\dev\dyson目录。这些内容是使用Oxygen XML Editor、Windows画图等工具创建的。

最后,我们对内容进行提交并推送到Gitee服务器。

请在Description输入栏中输入这次做了什么变动,以后我们通过看Description知道每次提交做了哪些修改。

我们可以多次执行这一步,每次提交都会被记录在git中。

如果别的团队成员之前做过提交和推送的动作,那么在Github Desktop上可以看到"Pull Origin - 1"这样的界面。点击“Pull Origin"会将最新的代码从gitee拉到本地并与你的修改合并,这样可以防止覆盖其他成员的修改。

3. 1.0定稿

当内容修订完成,我们对内容进行发布。

如果发布结果通过了审核,开始正式生效。那么我们在gitee上为当前内容创建标签(Tag):

标签记录的是当前这一时刻内容仓库的内容。随着时间推移,内容会被修改。未来某一天,我们可以通过这个标签获得当前这一刻的内容。

4. 为2.0做修改

在文件夹中增加新的文件或者对已经存在的文件做修改,然后发布文件为PDF等格式。

启动内容审核流程,对内容进行定稿发布2.0版的内容。

5. 2.0 定稿

遵循第3步所列步骤,创建V2.0的标签。

后续版本修订遵循以上第4步和第5步。

- 3 -

其他操作

1. 查看变更

- 4 -

总结

引入版本管理功能以后,能够实现:

  • 记录每个文件变更的历史,随时可以获取历史版本内容

  • 避免团队成员之间覆盖对方的修改

  • 不担心在个人点因磁盘损坏或者设备丢失造成内容丢失

 

 

 

相关内容

热门资讯

安装新风系统有灰尘吗,安装新风... 安装新风系统,告别室内灰尘困扰?随着生活水平的提高,人们对居住环境的要求也越来越高。灰尘问题一直是家...
安卓系统怎么安装鸿蒙,安卓系统... 安卓系统如何安装鸿蒙系统——全面指南一、了解鸿蒙系统鸿蒙系统(HarmonyOS)是华为自主研发的操...
安装新风系统后不热,安装新风系... 安装新风系统,告别夏季炎热,享受清凉家居生活随着夏季的到来,高温和潮湿的天气让许多人感到不适。传统的...
奥迪监控系统安装,提升行车安全... 奥迪监控系统安装:提升行车安全与便利性的智能升级一、奥迪监控系统安装概述奥迪监控系统主要包括车视野全...
安装正版系统详细教程图,安装正... 安装正版系统详细教程图解随着电脑使用时间的增长,系统可能会出现各种问题,重装系统成为了解决问题的有效...
安装新系统鼠标,安装新系统后鼠... 安装新系统后鼠标无法使用?快速解决指南在安装新操作系统后,遇到鼠标无法使用的情况并不罕见。本文将为您...
拜腾系统安装,拜腾系统安装指南 拜腾系统安装指南在开始安装拜腾系统之前,请确保您已经做好了以下准备工作: 一台电脑或平板电脑,用于...
安装新主板和cpu后怎么安装系... 安装新主板和CPU后如何安装系统准备工作在开始安装系统之前,我们需要做好以下准备工作: 备份重...
安装语音启动系统教程,榧庝俊补... 安装语音启动系统教程 一、前言 二、准备工作在开始安装之前,请确保您的设备满足以下条件: 操作系统...
安卓电视系统如何安装,安卓电视... 安卓电视系统安装指南随着智能电视的普及,越来越多的用户选择使用安卓电视系统。安卓电视系统不仅操作简便...
安装销售监控系统的好处,提升企... 安装销售监控系统:提升企业竞争力的五大优势随着市场竞争的日益激烈,企业对于销售环节的精细化管理需求越...
安装萤石系统多少钱,萤石云视频... 萤石系统安装费用一览:性价比与服务的完美结合随着社会安全意识的不断提高,家庭和企业对视频监控系统的需...
把win系统安装到u盘安装,如... 如何将Windows系统安装到U盘在开始安装之前,请确保您已经准备好了以下物品: 一个空的U盘,建...
安装小猫停车场系统,小猫停车场... 小猫停车场系统安装指南随着城市化进程的加快,停车难问题日益凸显。小猫停车场系统作为一种智能化的停车解...
安装系统重启只有光标,安装系统... 安装系统后重启只出现光标怎么办?全面解析及解决方案在电脑使用过程中,遇到安装系统后重启只出现光标的情...
请问个税系统怎么安装,轻松掌握... 个税系统安装指南:轻松掌握个税申报流程随着个人所得税改革的深入推进,个税系统的安装和使用变得越来越重...
安装隐藏子系统,安装隐藏子系统... 安装隐藏子系统的详细指南随着计算机技术的发展,隐藏子系统成为了许多高级用户和系统管理员追求的目标。隐...
安装造价给水系统,安装造价给水... 安装造价给水系统概述安装造价给水系统是建筑给水工程的重要组成部分,它负责将水从水源地输送到建筑物内部...
宝马环视系统安装,提升驾驶安全... 宝马环视系统安装:提升驾驶安全与便利性的智能升级随着汽车技术的不断发展,越来越多的智能辅助系统被应用...
安装系统字体没了,系统字体丢失... 系统字体丢失怎么办?教你轻松找回和安装在电脑使用过程中,我们可能会遇到系统字体丢失的情况,这不仅影响...