这两天在开发一个关于按钮的功能，然后需要进行一些通信和确认。前一阵子基本上都在划水跟看看协议之类的东西，把大概的框架写了写，然后今天打算把整个项目细节扣一下。
结果，我在扣的过程当中发现，很多变量和结构都得重构，前面基本相当于白写了，而且整个系统的流程其实还是比较复杂的。听了一个比较老的程序员的话：
先写文档，再开发。
写开发文档在开发过程当中真的是一件很重要的事情，程序员之所以很讨厌产品经理，就是因为产品经理在不断的提需求，有时候一个需求就代表着里面的一个小模块的重构。
开发文档一——写需求
需求包括了你写的这个项目总共要实现什么功能，阶段性要解决什么问题，要留有后期可扩展的哪些部分。
功能这个必须先确定了再进行开发，不然要改功能真的非常痛苦。就算后期要改某些功能，最好把这些参数做成开放式的，写在参数文档里，然后重新写一个函数就可以接进去。
开发文档二——写流程
一个比较大型的模块一般都会有很多流程的确认，同时模块与模块之间的交互也会很复杂，在开发之前把所有的流程图画出来，然后确认一下要定义的消息类型有没有遗漏的，把每一个模块的消息变量写出来。
开发文档三——后期支持可扩展
虽然我们只是一个程序员，但是我们得告诉那些做规划的人后面什么是可以加的，什么是不可以加的，这样项目经理才对这个系统的可扩展性有一个概念，不然他们以为什么都可以往里面加。
大概就是这么几个要点，如果有人经常写开发文档的，可以留言交流。
网友评论