一、前言
一项工作的落地,必然是要有输出,其中重要的输出就是相关文档。
文档的作用就是记录这这一项工作的推进过程以及结果,方便其它人能快速理解上手该项目。
那么我们一般有哪些文档的?
对于团队角度而言,文档一般包括:需求文档,详细设计文档,接口文档,测试用例,测试报告,学习计划文档,引进新技术落地方案,业务系统操作文档,技术分享文档等等。
如果没有一套文档管理规范,那么可能造成的结果就是,没有相关文档,文档分散存放,文档内容混乱,质量太差,结果就是必须靠人传人才能把这个事情说清楚,最终的结果就是效率低下。
对于个人知识体系而言,文档一般包括:学习规划文档,技术文档,总结文档,知识库,日常记录等。
如果没有一套文档管理规范,那么可能造成的结果就是,知识点零散,无法形成一套完整的个人知识体系,缺少文档管理的能力。
如何做好这些文档的管理,以及文档内容编写规范则显得至关重要。
二、如何进行文档管理
团队文档
首先我们来进行归类,归类是文档管理的第一项工作,将合适的文档放在合适的位置。
1、需求相关:一个完整需求上线一般包含以下文档:需求文档,详细设计文档,接口文档,测试用例,测试报告,那么这些就应该集中挂载到需求下面。
2、技术相关:公司内部搭建wiki平台,按照职能区分,运维、开发、测试、产品,还有公共模块等,分类去存储。
对于团队的文档如何管理,相信每个团队都有自己的一套完善的管理方式,下面我就着重讲讲关于我个人的文档管理方式。
个人文档
选中好的工具,事半功倍。
我的王炸组合:有道云笔记+IDEA。
文档是一定要成体系化的,并且满足可移动、在线、跨多个终端,并且是轻量级的,基于这个需求我选择了有道云笔记。有道云笔记可以支持手机客户端,web端,pc端等等。并且可以实时多端同步,对于使用者来说是非常友好的。
我的文档主要分为四大类。
1、软件测试:主要包含一些测试相关的内容,Linux、Jenkins、Java、JMeter等等测试相关的技术。
2、搬砖日常:平时搬砖过程中的一些记录我都会放在这里。
3、知识库:这里会记录我学习的一些其它技能,包括学习产品知识、金融知识、做饭教程等等,有时候get到的一些小妙招都会在这里记录。
4、碎碎念:我的一些日常感悟都会记到这里。有时回顾起来真的很有意思的,每次回头看,以前觉得天要塌下来的时候,那都其实很正常,回顾笔记真的会感觉自己又成长了不少。
以下是我的有道云笔记结构,可供参考。
IDEA是一个开发编辑器,写代码的适合用来做文档管理吗?
非常适合,在测试过程中需要编写一些测试脚本,并且需要做调试,IDEA就非常满足这个需求。
并且有些测试文件,包括pdf、word、图片、JMeter脚本、或者一些jar包等等,通过IDEA集中存储,并且上传到github上面,实现办公家里同步,非常的方便!!!
以下是我的IDEA文档结构,可供参考。
三、总结
做好文档管理是非常重要的技能,有了这项技能能更好的搭建知识体系,重点要不定时回顾文档结构,及时调整到最合适的位置,让自己的知识体系更加的强大!