随着项目越来越多,项目深度越强,对维护项目和持续开发带来了不少麻烦。先前的开发我们都没有对开发文档进行很好的整理与规范,如果一个功能扔出来,不解释半天另一个猴子也很难对接功能或者接手继续开发。
程序猴子间的交流并不够简明,将直接带来沟通成本的提高。其实最佳的猴子交流方式一般是,所谓的:
No BB , Just show me the code !
好记性确实不如烂笔头,不断的技术迭代与积累才是发展的基础。就是酱,所以每一个有追求的公司都应该为项目规范今后的文档撰写方式。
PROJECT的开发文档目录结构
每个项目下都需要有一个目录名叫
-- readme
readme目录下,要有个文件叫roadmap.md,这个文件记录的东西包括:
- 功能节点的目标功能,以及负责人,完成时间等
- 需要完善的细节
- 一些特别重要的BUG
- 下个版本需要迭代的功能和新增的功能
- 一些重要的事件记录
readme文件目录下每一个开发猴子都需要以自己名字命名,如:
-- readme
roadmap.md
-- aaron
-- shuaige
-- dragon
每个猴子自己去管理自己的功能模块开发记录,根据自身习惯来记录,但无外乎记录的内容都要包含记录要点:
- 每个功能的主要逻辑实现思路,重要代码注释
- 功能实现的难点
- 自己的排期规划
- 自己认为需要迭代或重构的要点记录
- todo
- 需要给其他人对接的详细API接口
- 认为未来需要交接给其他人的细节会被记录
- 学习文档,未来可能会用到的代码记录
markdown语法参考
详细点的:
http://www.appinn.com/markdown/#hr
最简明的:
https://en.wikipedia.org/wiki/Markdown#Example
11种基本语法:
http://www.cnblogs.com/hnrainll/p/3514637.html