写文档说明书的一点心得

原创 2004年08月31日 18:57:00
    一直以来,老师同学朋友家人,都说自己特别聪明,记性好;而自己也始终这么认为,因为这毕竟是事实,也特自信,几乎什么都在脑袋里记着——上课的笔记,会上的讲话,公开的演讲也都是腹稿,将所有联系人的电话号码都记在脑子里,是挺好。可是,人呢,随着时间的推移,很多东西都会忘却,也可以叫做“新陈代谢”吧,是很正常的事情。
    当有一刻,你一旦忘掉某件事又非常想记起而始终记不起的时候,你就会觉得人的记忆力毕竟是短暂的。不知何时起,我习惯了把自己需要的东西都用笔写在特定的本子上,现在分门别类的本子已经有了10几本,有编程方面的,有数据库方面的,有网络方面的,有开发经验的,有人生感悟的,等等,记载着近几年来走过的风风雨雨,每个本子都是满载着心血,不小心弄丢了一本,愣是几天吃不下饭。就好比作家呕心沥血写了本书,结果未出版就把初稿弄丢了似的,你让他一字不差再重新写出来简直是太难啦。
    开发个小软件,一定要注明时间、功能等,就算隔的时间长了,拿出来也马上就能使用。尤其是这种小软件多了,3天不用,再使用的时候你就会手生。如果你是做客服,几天没有客户打电话咨询,猛地打来你也会有飘飘然的感觉。
    开发人员不能分开的当属是文档——需求说明书、总体设计说明书、详细设计说明书等等。一个好的项目开发团队,它的文档一定是非常详细的。因为你不可能一辈子在一个企业呆下去,软件也不可能不升级更新;就算将来你走了,有人来接你的班,只要有详尽的文档,一看就会明白,也算是为后来者铺路吧;同样的要更新升级,有前面细致的工作,你的后续工作才会相对的比较轻松。
    一个项目结束,那么意味着产品也就出来了。客户最关心的莫过于如何快速的来使用软件?所以一份详尽的操作说明书就是不可缺少的。对开发人员来说,必须充分考虑到客户是不具备专业知识的人。于是,字号要大于10号,以方便人们阅读;字体要用标准印刷体。接下来,对表现方法也要有具体要求,比如,句式一定要用单句,避免复合句;不用敬语和自谦语;一小节一个意思,一小节多少字之内;多用主动语态,少用被动语态;将专业用语减少到最低限度;不用代名词等。
    说明书必须站在客户立场,充分考虑通俗易懂的表达方式,少使用“不能如何如何”的句式,不要被客户产生被命令的感觉,从而对产品产生反感。
    说明书中也是少不了图形的,图形简单明了,用图形来解释产品的使用,也是不可或缺的。不仅形象地解释产品的功能和使用方法,而且图画中带有很强的感情倾向,使客户带着浓厚的兴趣进行安装和使用。
    因此,说明书中的图文并举现象,使文字说明形象化,让消费者更容易领会产品的功能和使用方法。
    最后,好的说明书可以代替服务热线,随着法律的完善和产品功能的增加,现在的说明书动不动就是一大厚本,让人看了后面就忘了前面。我前些日子给客户做了几次培训,发现半数以上的咨询是关于产品性能和使用方法等问题。而这些都清楚地写在说明书中,但消费者并没读到或没读懂。与其培训一批专业人员守在热线旁边,不如一开始就在说明书上下功夫,厂家省钱,消费者高兴,何乐而不为呢?

版权声明:本文为博主原创文章,未经博主允许不得转载。

如何编写好的用户手册?

How to Publish a Great User Manual
  • doris_d
  • doris_d
  • 2015年01月08日 17:08
  • 2455

详细设计说明书

详细设计说明书 1引言 1.1编写目的     本详细设计说明书,是在概要设计说明书的基础上进一步明确系统结构,详细的介绍系统的各个模块,为进行后面的编码和测试做准备。           预期读...
  • ZHOUCHAOQIANG
  • ZHOUCHAOQIANG
  • 2013年12月03日 17:04
  • 4076

数据库设计说明书

数据库设计说明书 1引言 1.1编写目的      数据库的设计是为了以后编码、测试以及维护阶段的后台数据的存储做准备。应用于系统开发前期,为后期数据库设计指引方向。     ...
  • ZHOUCHAOQIANG
  • ZHOUCHAOQIANG
  • 2013年12月05日 14:30
  • 8714

web服务器学习体会

web服务器其实就是一个应答器,他可以按照预先程序的设计响应客户端浏览器的所有问题。在这个响应的过程中,在网络上使用的是http协议,当然为了安全性后来出现了https协议,而传输的内容时符合HTML...
  • wgj99991111
  • wgj99991111
  • 2016年12月01日 15:10
  • 265

开发文档生成工具----强大的Doxygen工具使用手册

张三:假如我们自己开发了一个类库,怎么做一个方便阅读的文档呢? 李四:一个方法一个方法地写呗,就像写Excel文档一下。 张三:啊,你out了,这多慢呀。为什么不玩玩doxygen工具,它...
  • richie0006
  • richie0006
  • 2016年05月11日 14:13
  • 1785

MPlayer 使用手册中文版

播放文件 使用 MPlayer 播放媒体文件最简单的方式是: mplayer MPlayer 会自动检测文件的类型并加以播放,如果是音频文件,则会在命令行中显示该播放文件的状态信息;而假如是视 频文...
  • leixiaohua1020
  • leixiaohua1020
  • 2013年11月20日 15:33
  • 6266

如何编写高质量“软件需求说明书”

如何编写高质量“软件需求说明书”     你的工程应该有个好的起点。一个小组要带领客户进入需求启发阶段而且你要写软件需求说明书。这份说明有些大,但客户会很重视,所以说明必须得到赞同。...
  • xjbclz
  • xjbclz
  • 2016年06月20日 21:29
  • 484

软件工程文档编写总结

背景:在完成机房收费系统之后,自己亲身经历了软件文档的编写工作,在第一次编写验收不过的情况下,自己从18号到26号完成了自己的第二次编写工作。初次编写,感觉自己还是有很多东西没有了解,但是,自己的收获...
  • u010508826
  • u010508826
  • 2014年01月26日 21:00
  • 1865

一些关于vue的心得

vue,继angular、react之后又一前端框架。在使用vue开发的时候,也遇到了很多坑,希望在这里能够和大家分享,让大家在第一次使用的时候可以避开这些坑。   1.父组件向子组件通过props...
  • lfx574469153
  • lfx574469153
  • 2017年03月23日 11:15
  • 344

关于亲子阅读的体会

相信孩子成长的力量,相信孩子是颗有无穷生命力的种子,在宽容、宽松、自由、温暖的氛围里,自己发芽,自己成长,也让孩子这样氛围里去体验阅读的美和快乐。...
  • xjbx
  • xjbx
  • 2017年05月25日 14:05
  • 708
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:写文档说明书的一点心得
举报原因:
原因补充:

(最多只允许输入30个字)