文档团队怎样使用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 -

总结

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

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

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

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

 

 

 

相关内容

热门资讯

安卓免费私有云盘系统,探索安卓... 你有没有想过,你的手机里那些珍贵的照片、文件和视频,如果有一天突然丢失了,那该有多心疼啊!别担心,今...
安卓系统怎么装分身,安卓系统轻... 你是不是也和我一样,对安卓系统的分身功能充满了好奇?想要在手机上同时使用两个账号,但又不知道怎么操作...
安卓系统手机照片云恢复 手机里的照片丢失了,是不是瞬间感觉心情down到了谷底?别急,今天就来给你支个招,让你的安卓系统手机...
安卓系统的缓存怎么清,轻松优化... 手机用久了是不是感觉越来越卡?别急,今天就来教你怎么给安卓系统的缓存来个大扫除,让你的手机恢复活力!...
安卓4.4系统gps补丁 你知道吗?安卓4.4系统,也就是传说中的KitKat,可是智能手机界的一颗璀璨明珠呢!不过,就像所有...
安卓系统主界面设置,个性化与便... 你有没有发现,每次打开安卓手机,那主界面就像是个五彩斑斓的小天地?今天,就让我带你一起探索这个神奇的...
鼎桥是安卓系统吗,安卓系统背后... 你有没有听说过鼎桥这个品牌?最近它在手机市场上可是挺火的呢!不过,说到鼎桥,很多人都会好奇一个问题:...
红米note安卓7.0系统,畅... 你有没有发现,最近你的手机是不是有点儿不一样了?没错,就是那个陪伴你度过了无数日夜的红米Note,它...
安卓手机怎么安xp系统下载地址... 你有没有想过,把Windows XP这样的经典操作系统安装在安卓手机上?听起来是不是有点不可思议?但...
ios系统能转回安卓吗,iOS... 你有没有想过,手机系统之间的转换,就像是从一个熟悉的地方跳到另一个全新的世界呢?今天,我们就来聊聊这...
安卓系统怎么分屏聊天 你是不是也和我一样,手机里同时挂着好几个聊天窗口,一边和闺蜜聊着天,一边还得回复领导的邮件,感觉手忙...
苹果查安卓手机定位系统,安卓手... 你有没有想过,你的手机里藏着一个小秘密?没错,就是那个能让你随时随地找到它的神奇功能——定位系统。今...
安卓原生系统关闭锁定,轻松关闭... 你有没有发现,手机用久了,有时候安卓系统的锁定功能就像是个小顽皮,时不时地跳出来给你点小麻烦?别急,...
安卓系统的屏幕怎么调,安卓屏幕... 手机屏幕亮度总是调得刚刚好,是不是有点儿小烦恼呢?别急,今天就来手把手教你如何轻松调整安卓系统的屏幕...
光遇安卓系统崩了,官方紧急应对 最近光遇的安卓玩家们可真是有点头疼呢!你有没有发现,最近光遇安卓系统突然“崩了”,让不少玩家都陷入了...
安卓系统直播触摸大屏 你有没有想过,在安卓系统的世界里,直播和触摸大屏的结合能擦出怎样的火花呢?想象你正躺在沙发上,手捧着...
安卓系统映像预览版,前沿技术一... 你知道吗?最近安卓系统又出新花样了!这不,安卓系统映像预览版新鲜出炉,让我来带你一探究竟,看看这个新...
安卓系统如何防止死机,安卓系统... 手机突然卡顿,屏幕上那些图标就像被施了魔法一样,动也不动。你是不是也遇到过安卓系统死机的情况,心里那...
安卓系统手机自动播放,安卓手机... 你有没有发现,最近你的安卓手机是不是有点儿“调皮”呢?它总是在你最不想被打扰的时候,自动播放那些让你...
mini主机双系统安卓,轻松实... 你有没有想过,家里的电脑已经满足不了你的需求了?想要一台既能运行Windows系统,又能畅玩安卓应用...