站长之家 - 经验 2010-12-27T09:14:03 +08:00

如何才能写出好的产品文档

一般来说,产品文档分为产品需求文档和产品使用文档两种。产品需求文档主要面向的是产品的开发、设计者,期望是产品的实际开发人员了解产品的细节,让开发完成的产品达到前期设计需求的预期;产品使用文档面向的主要是使用者,使其通过产品文档掌握产品的功能使用,也就是我们常说的产品使用帮助;如果不搞清楚文档面向的对象,往往写出来达不到预想的效果。类似这样专业的文档文案,其实是有一定共通性的;掌握这类文案的写作技巧,尤其对我们IT从业人员来说,是一项非常不错的技能。笔者从业这两年,跟此类文档打过不少交道,在这里跟各位分享一些经验。

1、对象要清楚

开篇就提到了,清楚文档面向的对象的重要性。对于不同的对象,必须使用不同的写作思路来对待,尽可能的站在对方的角度去思考。他需要看到什么?什么内容对他有用?我如何阐述给他?对于产品设计人员,他所需要了解的是产品的样式、界面、交互等情况,对于实际编码人员,他则偏重于产品的可实现性,你的内容则需要偏注产品的功能细节和内部处理。所以,文档面向的对象决定了文档的功能和内容。确定文档面向的对象才能做到有的放矢。

2、条理要清晰

文档的条理清晰不仅让你的文档看起来比较顺畅,更让阅读者能够很清楚的理解。所以,下笔之前就应当知道自己的文档内容大致分为哪几个大的模块、模块下又细分了多少个子模块,然后在大纲的基础上,再进行详细的内容填充。笔者之前的经验,往往在文档下笔之前认真思考了好几天,总希望在下笔之前就希望把所有的问题都想清楚。这对于写作者来说,是一件不好的举动。其实,东西在脑子里转悠,不如在纸上来的直观。大纲列出来之后,然后再来反复的添加、修改,比你按笔不动要来的有效率得多。对于写作来说,最难的也是开始。

3、逻辑要严谨

产品类的文档不同于平常我们书写的文档类型。对于内容叙述的严谨性要求非常严格。因为你的文档不单单是一个你对这个项目、产品的理解,它更是需要做为一个协作的载体让其他的同事同时使用,更可能成为其他同事工作方向的指引。因此,严谨是必须的。所以,在满足了文档条理清楚的前提下,仔细斟酌、思考文档可能会出现歧义、漏缺的部分,反复修改文档成为了一项必须的工作。在大家协调工作的背景下,你一个人不可能将所有的问题都考虑清楚。所以往往出现同事指出你文档中存在的毛病和漏洞。但是你还是应当在前期多做一些考虑,将问题尽量减少。

4、用词要专业

专业的用词不当可以帮助你提升文档的专业度,更可以帮助你提升效率,减少重复和不必要的沟通成本。既然是行业那就需要行业标准,使用专业的行业术语是一种职业化的表现,这样既可以很快和同事达成共识,又让别人觉得你很专业。我想,同事之前这样的协作才是有效率的。当然,对于新手来说,如何掌握专业的用词,这就需要平时多看多读了。多了解小众的博客,多认识一些前辈和朋友,无论是对写作还是对工作的认识,都是很有帮助的。

5、格式要规范

对于一个IT行业从业人员来讲,规范化、流程化的工作模式是非常重要的。对于需要经他人手的文档、或者需要进行存档的文档来说,格式的规范与否是一个衡量你专业化程度高低的重要衡量标准。当然,说到这个规范,你在第一次写作之前就应该了解这个规范是一个什么样的规范。是行业规范?还是公司内部的规范?这取决于你所在公司或所从事项目的情况。对于大公司,你所要做的就是找之前前辈们写过的同类文档进行拜读,了解这些规范。对于小公司或者新创的项目,之前没有过同类产品文档的情况。你所要做的就是沿用标准规范再加上项目特点,尽可能细致的书写。相信,经过你的努力的,你写的文档将会成为该类文档的案例,成为规范。

其实无论是产品需求文档(PRD)、产品策划书还是商业计划书,其实都是需要我们下功夫仔细研究的。毕竟中国互联网发展才十几年,很多细节都还不是很专业。对于一个会思考的互联网人,武装自己的头脑,丰富自己的技能才能找到更好的职业发展。

(本文版权归IT泡泡堂www.3ppt.com站长所有,欢迎转载,转载请注明出处)

推荐关键词

24小时热搜

查看更多内容

大家正在看