首页 > 产品设计 > 如何写文档

如何写文档

2009年3月19日 发表评论 阅读评论

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

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

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

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

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

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

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

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

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

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

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

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

  1. 深圳王书生
    2009年3月20日10:04 | #1

    我们公司领导根本不重视文档。但是开发又老抱怨文档太烂。
    我们该怎么办呢?
    如果投入太多精力去写领导说你不务正业,如果不好好写开发说你水平不够。
    苦恼

  2. 2009年3月20日16:08 | #2

    文档不是写的越多越好,而是写的让看的人明白即可。你写的是需求文档,针对开发人员的,他们不喜欢看文字,但是流程图和效果图,他们就很容易接受,在写功能逻辑的同时,配上流程图,他们一看就明白了,也不需要花很多时间:)如果你还有什么苦恼,可以发上来看看,我们一同解决:)

  1. 2009年3月24日21:58 | #1

注意:
评论者允许使用'@user:'的方式将自己的评论通知另外评论者。
例如, ABC是本文的评论者之一,则使用'@ABC:'(不包括单引号)将会自动将您的评论发送给ABC。
user必须和评论者名相匹配,区分大小写。

SEO Powered by Platinum SEO from Techblissonline