网站开发执行文档(页面界面和功能说明文档)编写方法

作为一个有了10年WEB开发经验的老程序员,在项目开发中体会最多的就是,技术人员如何准确无误的理解PM/策划人员的需求。在一个项目中,因为沟通、理解能力或者只是遗忘导致设计/开发人员做出的最终结果往往与PM/策划人员理想的结果相差甚远。而这,往往是造成项目无法按时完成的一个主要原因,同时也是造成PM/策划与设计,开发人员矛盾的主要因素。

解决方法其实很简单,一个详细完全体现策划人员对页面需求的执行文档就能轻易解决这个问题。现在我们一般做项目都会有很多文档,比如需求文档,功能说明文档,测试用例等等,但很多策划人员往往对文档写的不是很仔细,重需求文档而轻具体的页面执行文档,他们往往认为自己完全能通过口头沟通来表达清楚自己的意思,而懒得去多写一个文档。特别是众多不太规范的小公司,往往没有专业网站策划人员,提出需求的不懂如何用文字表达自己需求,同时认为这个是浪费时间,而当最后开发做出的东西不符合自己要求时,却怪到开发缺乏理解能力和沟通能力。

这里我罗列了执行文档的几大优点,以说明写文档的重要性。

1、  减少沟通开销,写一份执行文档,可以给N个设计,开发人员查看,避免你需要向N个人去解释你的需求和想法。

2、  减少理解误差,策划口头讲解时,往往会因为表达能力和各人理解能力不同,造成每个人对界面和功能的理解不同,最后做出不想要的结果,而清晰明白书写在文档中的需求,可以避免此情况发生。

3、  减少遗漏和事后推诿,和上条一样,口头表达,听得人很有可能记不住所有策划提出的需求,而当有些功能漏做时,可能是策划忘记提出,可能是开发忘记实现,最坏结果会互相推诿,互相指责对方出错,影响互相关系。

4、  可作为测试的标准,测试人员可以通过该文档对功能正常流程进行测试,避免出现测试分不清哪些是BUG哪些是正常需求的情况。测试人员同样很难完全理解策划的需求。

5、  可作为开发人员考核的标准,开发哪些功能做好了,哪些没有做,根据文档所列一目了然,能做到公平公正,使人心服口服。

6、  可作为维护的必要文档,很多项目,一段时间后,换了项目人员后,对当初的想法和需求都不会很清晰,相信换人时交接工作前任不会对后任详细到能把所有需求都交代清楚,后任也不可能通过短短交接时间完全理解项目需求和功能,如果后任碰到不知道的情况去打扰前任,前任也不会开心,这时候有这些文档就可以很好解决这些问题。

以上优点总结起来就是能减少项目开发时间,提高开发质量,利于维护(降低团队人员出现矛盾的风险?)。

既然有那么多优点,那么我相信大多数项目管理人员,策划人员是愿意花点时间写几份网站开发执行文档的(团队特别强,沟通理解无压力的除外)。

那么如何来写一份合格的开发执行文档呢?我们需要先知道文档需要表达什么和如何表达。

文档中需要表达什么:

1、  界面布局,虽然界面设计是设计师的事情,但是相信如何布局是在策划脑子里的,策划也不愿意完全让设计师自由发挥的。

2、  交互功能,比如鼠标点击这个按钮会发生什么效果,鼠标移到这里会有什么变化,这些都是需要详细说明的。

3、  链接指向,跳转指向。

4、  表单验证规则,提示错误信息。

5、  界面上看不到的一些功能,比如新闻详细页需要记录浏览数量。

如何表达:

1、  界面布局可以画出草图,例如下图:

 

也有一些特殊情况是设计先于文档形成的,这样这里可以放已经做出的界面图,如下:

 

2、  互动的功能必须指明触发事件,一般为鼠标事件,比如鼠标点击,鼠标移入,移出,获得焦点,失去焦点,页面初始化等,一般不标明何事件默认为页面初始化时的状态。

3、  首页或列表页面等需要指明标题的长度(最多多少个字),每个列表的记录数,默认的排序规则等。

4、  表单验证,提示信息等有要求的可以在页面中标明,也可在专门的规则文档中说明。

5、  公共的头,尾部分(包括其他多次使用的界面和功能)只需要在第一个文档中写明,如果无变化则以后描述时都可以写上“同XX文档第X条”

6、  最好用1234的标号来标明不同的功能,利于开发和检查。

按照以上的方法基本就能写出一份合格的网站开发执行文档了,我这些只是我个人的经验之谈,实际情况各人尽不相同,需要写什么怎么写,我相信每个人也有各自不同的理解,总之最重要一点就是你写的文档能让设计和开发明确无误的理解你的意思并将之实现!

这里还有几点要注意的地方:

1、  每个文档名字都以页面名字命名,如首页执行文档(首页界面与功能说明文档),力争一目了然。

2、  保证执行文档和页面最终结果的一致性,每次发生修改,都必须修改相应执行文档,且在执行文档开头部分必须标注修改时间和修改内容。

 

最后附上我写的一个执行文档示范文档,很简单,但是意思表达明确。

http://download.csdn.net/detail/jzh2004/6195829

标签