前天，公司请MS的人来做交流，我也去听了一下，虽然只听懂了20％～30％，还有有翻译，尽管翻译的水平不咋的，连蒙带猜的大致上也能搞明白他在讲什么。其中让我印象最深感触最深的一个实践，是用wiki记录开发文档，其他人也可以修改文档，有新人加入时，就可以通过wiki进行学习，我深以为然。
昨天，老大提出，我们项目组也要组建公共知识库，也包括开发文档。有个同事提出，他倾向于使用Word文档来进行记录这些内容。这不禁让我开始思考，用wiki和用Word来记录开发文档，各有什么优缺点。
大体说来，我是倾向于用wiki的，因为我觉得wiki的形式更能鼓励人们不断跟着代码变化而自发地更新文档，并且wiki一般自带版本管理功能，使用更方便，另外一方面，开发文档并不需要多丰富多样的格式，有简单的文本和插图一般够用了，而Word文档拥有的其他功能，可算是累赘了，比如要比较两个版本的差异，就相对要麻烦一点点。
说到底，我其实最看重的是wiki形式的约束下，人们会更多地完善文档，我们项目组目前的一大问题是，并没有多少文档，代码中偶尔有几行注释就算是全部的文档了。假如我们也像产品开发人员那样有非常详细的从SRS到HLD，再到LLD，那用wiki和用Word文档，或者其他什么记录形式，根本没有区别。
感觉本文不错，不妨小额鼓励我一下！
支付宝扫一扫
微信扫一扫