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

总结

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

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

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

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

 

 

 

相关内容

热门资讯

安卓系统没有通话界面,探索安卓... 你有没有遇到过这种情况?手机屏幕上明明显示着通话界面,但是当你点进去的时候,却发现什么都没有?没错,...
安卓子系统没反应,安卓子系统故... 手机突然卡壳了,安卓子系统没反应,这可怎么办?别急,让我带你一步步排查,找出问题所在,让你的手机重焕...
安卓系统装树莓派,安卓系统下树... 你有没有想过,把安卓系统装到树莓派上,会是个什么样子呢?想象一个迷你的小树莓派,竟然能运行起我们熟悉...
海信操作系统和安卓,打造智能生... 你知道吗?在智能电视的世界里,操作系统可是个大角色呢!今天,咱们就来聊聊海信的操作系统和安卓,看看它...
召唤抽奖系统1.9安卓pc,惊... 你知道吗?最近网上掀起了一股热潮,那就是召唤抽奖系统1.9安卓PC版。这款游戏可是让不少玩家为之疯狂...
安卓如何导入鸿蒙系统文件,鸿蒙... 你有没有想过,让你的安卓手机也来个华丽变身,体验一下鸿蒙系统的魅力呢?别急,今天就来手把手教你如何导...
安卓系统播放sd卡音乐,轻松播... 你有没有遇到过这种情况:手机里存了满满的音乐,却因为系统的问题无法顺畅播放?别急,今天就来给你详细说...
安卓软件内容转苹果系统,探索苹... 你有没有想过,那些在安卓手机上用得得心应手的软件,怎么就能无缝迁移到苹果系统上呢?这可不是简单的复制...
安卓原生系统无线投屏,轻松实现... 亲爱的手机控们,你是否有过这样的体验:坐在沙发上,手里拿着手机,却想在大屏幕上享受游戏或者电影的乐趣...
华为是什么安卓系统版本,探索H... 你知道吗?华为这款手机界的佼佼者,最近又引起了大家的热议。话题是什么呢?就是——华为是什么安卓系统版...
安卓大屏系统怎么更新,轻松实现... 你有没有发现,你的安卓大屏手机最近有点儿慢吞吞的?别急,这可能是时候给你的手机来个“大变身”了——更...
安卓cf怎么转苹果系统,轻松实... 你是不是也和我一样,对安卓CF这款游戏爱得深沉,但又想体验一下苹果系统的独特魅力呢?别急,今天就来手...
怎样关闭安卓双系统,一键操作指... 你是不是也和我一样,手机里装了安卓双系统,有时候觉得有点乱糟糟的,想要关闭其中一个系统呢?别急,今天...
安卓9系统特点不包括,提升了增... 你有没有发现,每次手机系统更新,都像是一场科技盛宴,让人兴奋不已?不过,你知道吗?安卓9系统虽然带来...
恋夜视频安卓系统Uc,恋夜视频... 亲爱的读者,你是否曾在深夜时分,被手机屏幕上跳动的视频吸引?今天,就让我带你一探究竟,揭开恋夜视频安...
鸿蒙套娃安卓系统视频,融合与创... 你知道吗?最近科技圈可是炸开了锅,因为华为的新操作系统鸿蒙OS又有了新动作。这不,他们竟然把鸿蒙套娃...
xp系统连接安卓手机问题,实用... 你有没有遇到过这样的情况:你的电脑上还运行着那个经典的XP系统,而你的安卓手机却时不时地想要和你亲密...
压缩安卓系统储存空间,高效管理... 手机里的照片越来越多,游戏也越玩越上瘾,可这安卓系统的储存空间却越来越紧张,是不是感觉像是在挤牙膏?...
安卓手游转苹果系统教程,轻松实... 你是不是也和我一样,手头有一堆安卓手游,突然之间想换换口味,体验一下苹果系统的魅力呢?别急,今天就来...
安卓原生系统锁屏暗,安卓系统锁... 亲爱的手机控们,你是否曾为安卓手机锁屏时的暗模式而感到好奇?那种在夜晚或光线不足的环境中,屏幕自动调...