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

总结

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

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

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

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

 

 

 

相关内容

热门资讯

电视安卓系统哪个品牌好,哪家品... 你有没有想过,家里的电视是不是该升级换代了呢?现在市面上电视品牌琳琅满目,各种操作系统也是让人眼花缭...
安卓会员管理系统怎么用,提升服... 你有没有想过,手机里那些你爱不释手的APP,背后其实有个强大的会员管理系统在默默支持呢?没错,就是那...
安卓系统软件使用技巧,解锁软件... 你有没有发现,用安卓手机的时候,总有一些小技巧能让你玩得更溜?别小看了这些小细节,它们可是能让你的手...
安卓系统提示音替换 你知道吗?手机里那个时不时响起的提示音,有时候真的能让人心情大好,有时候又让人抓狂不已。今天,就让我...
安卓开机不了系统更新 手机突然开不了机,系统更新还卡在那里,这可真是让人头疼的问题啊!你是不是也遇到了这种情况?别急,今天...
安卓系统中微信视频,安卓系统下... 你有没有发现,现在用手机聊天,视频通话简直成了标配!尤其是咱们安卓系统的小伙伴们,微信视频功能更是用...
安卓系统是服务器,服务器端的智... 你知道吗?在科技的世界里,安卓系统可是个超级明星呢!它不仅仅是个手机操作系统,竟然还能成为服务器的得...
pc电脑安卓系统下载软件,轻松... 你有没有想过,你的PC电脑上安装了安卓系统,是不是瞬间觉得世界都大不一样了呢?没错,就是那种“一机在...
电影院购票系统安卓,便捷观影新... 你有没有想过,在繁忙的生活中,一部好电影就像是一剂强心针,能瞬间让你放松心情?而我今天要和你分享的,...
安卓系统可以写程序? 你有没有想过,安卓系统竟然也能写程序呢?没错,你没听错!这个我们日常使用的智能手机操作系统,竟然有着...
安卓系统架构书籍推荐,权威书籍... 你有没有想过,想要深入了解安卓系统架构,却不知道从何下手?别急,今天我就要给你推荐几本超级实用的书籍...
安卓系统看到的炸弹,技术解析与... 安卓系统看到的炸弹——揭秘手机中的隐形威胁在数字化时代,智能手机已经成为我们生活中不可或缺的一部分。...
鸿蒙系统有安卓文件,畅享多平台... 你知道吗?最近在科技圈里,有个大新闻可是闹得沸沸扬扬的,那就是鸿蒙系统竟然有了安卓文件!是不是觉得有...
宝马安卓车机系统切换,驾驭未来... 你有没有发现,现在的汽车越来越智能了?尤其是那些豪华品牌,比如宝马,它们的内饰里那个大屏幕,简直就像...
p30退回安卓系统 你有没有听说最近P30的用户们都在忙活一件大事?没错,就是他们的手机要退回安卓系统啦!这可不是一个简...
oppoa57安卓原生系统,原... 你有没有发现,最近OPPO A57这款手机在安卓原生系统上的表现真是让人眼前一亮呢?今天,就让我带你...
安卓系统输入法联想,安卓系统输... 你有没有发现,手机上的输入法真的是个神奇的小助手呢?尤其是安卓系统的输入法,简直就是智能生活的点睛之...
怎么进入安卓刷机系统,安卓刷机... 亲爱的手机控们,你是否曾对安卓手机的刷机系统充满好奇?想要解锁手机潜能,体验全新的系统魅力?别急,今...
安卓系统程序有病毒 你知道吗?在这个数字化时代,手机已经成了我们生活中不可或缺的好伙伴。但是,你知道吗?即使是安卓系统,...
奥迪中控安卓系统下载,畅享智能... 你有没有发现,现在汽车的中控系统越来越智能了?尤其是奥迪这种豪华品牌,他们的中控系统简直就是科技与艺...