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

总结

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

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

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

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

 

 

 

相关内容

热门资讯

2028年黄金重返5600美元... 最近高盛预测金价将在2028年底回到每盎司5600美元,这引发了人们的关注。与其质疑这一预测的准确性...
台湾服务业生意雪崩哀鸿遍野 股... 台股近期连续大跌,加权指数从10月6日的近5万点下挫至目前跌了1万多点,跌幅约22%,近4天内就崩掉...
ANT上市 7位创始人身家破百... AI企业Anthropic将于今晚在美国纳斯达克上市,股票代码为“ANT”。发行价定为83美元,高于...
高志凯:世界需要深圳APEC ... 深圳APEC会议即将开幕,全球目光将聚焦这座因改革开放而闻名的城市。著名国际关系学者、全球化智库副主...
深圳值得被世界看见的远不止创新... 金秋11月,全球科技创新与经贸合作聚焦深圳。人工智能已融入深圳的方方面面:机场刷脸秒过、公园无人机送...
白小纯竞燃之夜造型 暖心护送旅... 白小纯竞燃之夜造型 暖心护送旅客出站!11月18日,上饶站接到重点旅客预约工单,提前与旅客沟通出行信...
中方回应中日领导人APEC是否... 中国外交部发言人郭嘉昆19日主持例行记者会。有记者问及APEC会议期间中日领导人是否会举行会晤。郭嘉...
黄牛炒茅台近乎无利可图,酒厂逐... 持续近十年的茅台渠道价差生意正在走向终局。继11月11日i茅台将精品、生肖等16款非标产品由抢购改为...
四川平武通报“游客称1600元... 近日,四川绵阳一游客称花1600元在平武县一民宿预订烤全羊,上桌发现几乎全是骨架,剥离下来的羊肉重量...
40万装修婚房业主说下水口成喷... 於女士在杭州杨家春晓南苑有套位于二楼的房子,一楼是商铺。她说花了40多万重新装修,给儿子当婚房,前段...
小区交房3年多暖气没通 物业:... 漯河市临颍县华寓精英名都小区宣传时是"双气学区房",但交房3年多,暖气主管道仍在小区直线距离约一公里...
房卡刷开一层楼涉事前台被开除 ... 11月18日,网友称在四川九寨沟入住一家酒店,发现自己的房卡能刷开同层多间客房房门。视频中,拍摄者拿...
11名孩子爬山迷路爬丢9个 孩... 11月19日(发布),天津蓟州,11名孩子爬山时迷路,爬“丢”9个,其中2个先下了山。消防员边找人边...
张雪两张“挡泥板票”均50万成... 11月18日晚,张雪在直播中拍卖两张11月22日张雪机车WSBK嘉年华活动的挡泥板票,其中一张是张雪...
中方回应日媒称高市早苗接机仪式... 11月19日,外交部发言人郭嘉昆主持例行记者会。会上,日本朝日新闻记者提问,关于APEC峰会期间对访...
1991年出生的人被小学生试题... 最近,一些小学语文试卷中的细节引发了80后家长的共鸣。家长们在辅导孩子作业时发现,习题和阅读理解中出...
正式供暖后您家室温达标了吗 暖... 从11月15日起,海淀区正式达标供热,规定要求供热单位保证居民住宅卧室、起居室的室内温度不低于18℃...
田栩宁不栩此行 武夷山采风之旅 田栩宁不栩此行 武夷山采风之旅!11月17日,田栩宁发布了《Madame Figaro》中文版202...
巨头集体入局具身大脑 物理AI被视为人工智能的下一波浪潮。国内外巨头接连发布物理AI新品,且尤为集中在具身大脑领域。英伟达...
APEC强劲发力激活亚太经贸新... 亚太经合组织第三十三次领导人非正式会议将于11月18日至19日在深圳举行,这是中国第三次担任APEC...