如何写文档（二）

 

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

一、 概述

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

二、 文档适用范围

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

三、 文档名称命名

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

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

² 产品人员：

² 版本号：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删除）变更相关内容体现在版本信息中。

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

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