存档

文章标签 ‘需求文档’

如何写文档(二)

2009年3月24日 没有评论


很多朋友对写文档很困惑,之前有一篇文章写过如何写文档,下面给出简单的范例,因为保密原则,不能网站提供,并去掉部分和公司相关的信息:

一、 概述

文档规范的制订,以需求的起草、审核、开发、发布都有据可查为目标,在需求上线中的各个环节,减少沟通成本。此版本为试用版。

二、 文档适用范围

本文档适用于功能逻辑的建立和变更。不适用于细节修改和产品页面优化部分。

三、 文档名称命名

产品名称_模块名称+版本号+产品人员+时间+文档状态

² 需求名称:产品名称+模块名称

² 产品人员:

² 版本号:01开始,指修改次数

² 时间格式:20090108

² 文档状态:

n 草稿

n 正式发布(指:提交需求立项,并通过产品、开发评审)在这个阶段提交文档集成。

n 正在修改

n 已上线(产品上线)如果需求有变更,需要完善文档保持和现上需求一致,并再次提交文档集成。

例如:注册功能功能需求,已经完成初稿,提交开发审核并通过,修改三次,版本号为03,文档名称为:

注册模块_注册功能需求文档_03_celine_20080909_正式提交开发

四、 文档编写原则:

1. 可行:指需求内容是在现有条件下是可以实现的。

2. 可测试:测试人员可以根据需求,建立测试用例。

3. 可跟踪:产品人员、开发人员和测试人员都能从文档中找到功能描述来源

4. 正确:文档的行文应当十分确切,不能出现多义性和歧义性的描述。

5. 完整:功能点有多条分支,要完整、全面的描述出来,不能使用以此类推等文字代替,每个分支都要描述清楚。

6. 无歧异:语言描述符合大众的认知,需求内容做到开发人员和测试人员的理解一致。

7. 一致:上下文中的描述语言,语义一致,应是不矛盾的。

8. 可定级:可以制定优先级。

9. 图片的添加,请现在ps中把图片压缩一下,在插入到word文档中,这样可以有效控制文档字节数。每张图片尽量控制在100k以内。

五、 文档修改原则:

ü 文档名称记录修改版本

ü 增加:黑色 宋体,变更相关内容体现在版本信息中。

ü 删除:双删除线,标注删除日期。变更相关内容体现在版本信息中。

范例:双删除线,标注删除日期。(2009-2-10删除变更相关内容体现在版本信息中。

ü 修改:字体颜色+修改日期,变更相关内容体现在版本信息中。

范例:字体颜色+修改日期 ,变更相关内容体现在版本信息中。


如何写文档

2009年3月19日 2 条评论

因为工作原因,这两天看了很多文档,风格各异,看的很吃力。文档能力应该是现代人的基本能力,大学毕业、走上社会必须要面对的文档:简历、其次就是工作报告、年终总结、需求文档、开发文档、产品说明文档,等等。

根据个人经验,我认为一份好的需求文档应该具备如下特性:

1. 可行性:文档中的内容,是否可以被执行。

2. 一致性:文档中的语义,保持一致性。

3. 正确、无歧义:文档的内容,要保证不同的读者都能够有相同的理解。

4. 完整:文档对某个要素的描述,要完整。

具体来讲,一份需求文档可以按照如下思路来描述:

首先要描述需求产生的背景-这个需求是在什么情况下才会产生的。

其次说明需求能达到什么效果,就是目标。

接下来就是描述需求的功能点,包括功能流程、功能描述、页面效果。需求文档是给开发看的,需求写出来要让开发明白要开发出什么的样的程序出来。

文档名称的命名,也有小窍门。你给领导发的文档,如果领导只看你一个人的文档的话,文档名称不必太强调。试想领导每天收很多文档,怎么知道那个是你的呢?所以,文档名称命名,很重要,所以名称包括几个内容:项目名称_需求名称+版本号_提交时间_您的大名。这样,文档名字就具备一定的自我说明功能了。

当然在流程规范的公司,会有严格的文档命名规范来进行这些约束。本文内容,适用于在没有文档管理流程、没有文档写作规范的组织中工作的文档撰写人员参考。


SEO Powered by Platinum SEO from Techblissonline