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

总结

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

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

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

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

 

 

 

相关内容

热门资讯

安卓系统对比骁龙,性能与生态的... 你有没有想过,为什么你的手机里装的是安卓系统,而不是苹果的iOS呢?又或者,为什么你的安卓手机里搭载...
qt程序安卓系统运行,基于Qt... 你有没有想过,为什么有些手机上的程序运行得那么顺畅,而有些却总是卡得让人抓狂?今天,就让我来给你揭秘...
安卓系统免费应用推荐,助你畅享... 手机里的应用是不是越来越多,有时候都挑花眼了呢?别急,今天我就来给你推荐一些安卓系统上的免费应用,让...
安卓系统视频通话app,打造无... 你有没有发现,现在手机上的视频通话功能越来越强大了?尤其是安卓系统上的那些视频通话app,简直让人爱...
安卓系统发现高危病毒,守护手机... 亲爱的手机用户们,最近可是有个大消息在安卓系统用户群里炸开了锅!没错,就是安卓系统发现了一款高危病毒...
安卓系统疯狂弹广告,揭秘广告软... 你有没有遇到过这种情况?手机里突然弹出一个广告,让你瞬间心情大崩溃?没错,说的就是安卓系统那让人头疼...
ebook 10进入安卓系统 你有没有发现,最近你的安卓手机里多了一个新伙伴——那就是电子书(ebook)10!没错,就是那个我们...
安卓系统如何调听筒,安卓系统调... 手机听筒声音突然变小了?别急,让我来教你如何轻松调教安卓系统的听筒,让它重新恢复活力!一、检查音量设...
安卓系统是怎么手机,解锁智能生... 你有没有想过,我们每天不离手的安卓手机,它背后的安卓系统究竟是怎么一回事呢?今天,就让我带你一探究竟...
安卓系统能代替windows系... 你有没有想过,我们日常使用的安卓系统和Windows系统,哪个才是真正的霸主呢?是不是有时候觉得安卓...
lp108安卓系统,功能特点与... 你有没有听说最近LP108安卓系统火得一塌糊涂?没错,就是那个让无数手机用户都为之疯狂的新系统!今天...
安卓系统挂载u盘,轻松实现数据... 你有没有想过,你的安卓手机或平板电脑突然变成了一个移动的U盘?没错,就是那种可以随意存取文件的神奇设...
i5 安卓系统,引领智能终端新... 你有没有想过,为什么你的手机总是卡得要命,而别人的手机却能流畅如丝?是不是因为你的手机搭载了那个传说...
安卓手机系统没有升级,揭秘潜在... 你有没有发现,你的安卓手机系统好像好久没升级了呢?是不是觉得有点out了?别急,今天就来给你详细聊聊...
安卓14系统定制v,创新功能与... 你知道吗?最近安卓系统又出新花样了!安卓14系统定制版V,这名字听起来就让人兴奋不已。今天,就让我带...
手机安卓系统越高越好,探索最新... 你有没有发现,每次手机更新系统,你的手机就像脱胎换骨了一样?没错,说的就是你,那个安卓手机!今天,咱...
鸿蒙系统怎么用回安卓,轻松实现... 你是不是也和我一样,对鸿蒙系统的新鲜感还没过,却又忍不住想回到熟悉的安卓世界?别急,今天就来手把手教...
苹果7跟安卓系统,性能对决与用... 你有没有想过,为什么苹果7那么受欢迎,而安卓系统却有着庞大的用户群体?今天,我们就来聊聊这个话题,看...
安卓手机刷简化系统,轻松实现流... 你有没有想过,你的安卓手机其实可以变得更加轻快、流畅呢?没错,就是通过刷简化系统!今天,就让我带你一...
社保掌上通安卓系统,轻松掌握在... 你有没有发现,现在的生活越来越离不开手机了?无论是购物、聊天还是办公,手机都能轻松搞定。这不,今天就...