团队知识传承:创业公司开发团队

1/20/2014

This content is not available in your language. The following is the Simplified Chinese version.

**摘要信息:**为知笔记的开发团队,每天都通过为知笔记来对开发人员进行管理,包括:开发过程中的沟通交流、布置开发任务、分析问题、总结经验,建立代码规范等管理内容。

为知笔记 CTO 讲述如何用为知笔记进行团队知识管理

作为为知笔记开发团队,我们一直是为知笔记团队功能最早的使用者。而很多功能,也是在我们自身使用的时候提出来的。例如@功能,评论功能等等。

在刚开始使用群组的时候,大家会把各种资料放在群组里面,最终导致群组内的笔记越来越多,即使良好地使用分类功能,也不能方便找到自己感兴趣的内容,直到我们开发出了@功能后,我们的团队使用效率得以再次获得提升。下面是我们使用团队功能的介绍以及一些实用技巧。

1. 群组里面的分类

在公司下面,有一个开发中心群组。里面记录的,并不是开发人员每天的工作日志等,而是一些大家在开发中遇到的各种问题,使用的各种技巧,或者是收集的各种开发资料,还有一些是编码规范。也就是说,这里面的资料,都是开发人员在平时工作中积累的点点滴滴。下面是这个群组里面常见的内容:

a92afa74-e6a6-4353-95a1-83502d057015_4_files/515798296.png

(1) 代码分析:

这个里面,我们会不定期的进行代码审查,并把一些遇到的问题,记录在这个目录下面,以便以后不再犯类似的问题。

(2) 代码规范:

常见的一些代码规范,例如Java, C++, Objective C的一些常见代码规范。属于新入职开发人员必读的内容。

(3) 技术资料:

通常是大家搜集的一些技术资料。

(4) 开发技巧:

通常是开发过程中,使用的一些技巧,并且认为值得分享的哪些技巧。

(5) 深层次 bug

这是一个非常重要的文件夹,而且里面的笔记,全部都是我们原创的内容。这里面通常记录的是一些比较难以发现的bug,尤其是一些开发环境下无法重现,只有在用户那里才可以出现的一些 bug。出现这些 bug 的时候,一般都会消耗很长时间去追查这个问题。因此这些问题,是非常值得我们注意并且避免以后重犯,否则追查这些 bug 的成本是非常高的。所以我们专门有这样一个分类,去记录每一个这种问题产生的根源以及解决的办法。

(6) 文档

这个文件夹里面记录了各个产品之间定义的 api 以及调用规范等等。例如同步 api 以及每一个 api 的参数,返回值等等。

2. 使用技巧

(1) 使用 markdown 语法来书写笔记

开发中心里面,大部分笔记都是采用 markdown 语法来编写的。一方面,markdown 使用简单。另一方面,也可以让笔记格式统一,方便阅读。

(2) 使用@和评论功能

当完成一篇文档类型的笔记的时候,通常需要通知相关的开发人员。传统的方式,我们可能需要复制内容,或者通过qq 等告诉对方已经放在 XX 群组的 XX 目录下面了,标题是什么,让对方去查看。这种方式无疑效率低下。此时,我们只需要在标题里面,加上 @all  或者 @XXX @YYY  这样的内容,对方就可以在为知笔记的消息中心里面,看到相应的通知,并直接看到对应的笔记,从而省去从大量的笔记中查找相关笔记的时间。

同样,当我们浏览他人笔记的时候,也会有进行评论的需求,尤其是开发文档或者开发技巧的时候,经常会进行点评。这时候,就会利用为知笔记的评论功能。笔记被评论后,笔记的作者也会收到相应的消息,方便进行回复。在下一步的开发计划中,评论的时候,也将会允许使用@功能,让评论就像微博那样,方便进行交流并给相关人员进行通知。

3. 总结

在我们使用为知笔记群组功能进行开发工作这一段时间,开发文档的编写和管理逐渐不再是一种负担,工作中遇到的各种问题也有了记录,并且可以让这些知识积累下来,即使有人员流动,但是他的成果和历史记录却可以永久的保留下来,并为新来的同事提供持续的帮助。

来自为知笔记(Wiz)