写文档说明书的一点心得

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

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/jaminwm/article/details/90353

任务管理系统设计和说明文档

  • 2017年11月06日 16:07
  • 1.47MB
  • 下载

系统架构说明书模板

  • 2013年04月08日 23:46
  • 277KB
  • 下载

软件开发中文档设计之我见

      在国内很少有IT公司把文档设计列为软件设计的一部份,也许很多是出于开发成本的考虑,因为要做文档设计,则必定要耗费更多的人力和时间,也即要付出更多的成本,我也对此曾经感到疑惑,国内IT公司竞...
  • dznlong
  • dznlong
  • 2007-09-17 14:36:00
  • 3138

软件开发的文档与审查

软件开发的文档与审查 软件开发必须过程化,必然需要文档的辅助。需要写文档是毋庸置疑的,这包括:需求分析文档、设计文档等。但没搞过这个的项目团队,往往抓不住重点,走入一些误区。  1.没有大...
  • dotedy
  • dotedy
  • 2015-10-23 14:22:49
  • 749

软件开发过程 & 文档

在软件开发的过程中,为了有效地进行开发和管理,人们往往根据经验规律,形成一定的模式。将开发过程分成几个阶段,每个阶段都有明确的任务,并且需要产生一定规格的文档资料交付给下一个阶段,下一个阶段在上阶段的...
  • liliang9425
  • liliang9425
  • 2014-01-28 16:02:21
  • 913

软件开发文档范例

对于软件工程学科的同学都知道,软件工程是一门技术含量高设计极其复杂的学科。为了控制好软件产品质量和规范,就必须用大量的文档约束软件工程的进度和状态。浩大的软件工程对于缺少工作和项目经验的人来说,必然是...
  • SunCherryDream
  • SunCherryDream
  • 2014-04-08 09:11:35
  • 46169

软件设计文档——概要设计书

概要设计的基本任务 (1)设计软件系统结构 a.采用某种设计方法,将一个复杂的系统按功能划分成模块 b.确定每个模块的功能 c.确定模块之间的调用关系 d.确定模块之间的接口,即模块之间传递...
  • bb1990521
  • bb1990521
  • 2015-05-17 21:53:12
  • 538

OA系统文档

OA系统需求说明书 1引言... 21.1编写目的... 21.2背景... 21.3定义... 21.4参考资料... 22任务概述... 22.1目标... 22.2用户的特点... 32.3假定...
  • zhangchen124
  • zhangchen124
  • 2017-04-21 16:02:02
  • 1351

...<em>+说明文档</em>(包括所有的需要<em>说明文档</em>)+开题报告+论文+源码-<em>CSDN</em>...

智能物业管理<em>系统</em>源码运用微软的asp.net/C#+sqlserver2000+sqlserver2005<em>+说明文档</em>随着智能化物业的发展、普及及网络技术的快速提升,计算机技术、网络技术已经广泛和...
  • 2018年04月09日 00:00

ARM的一点心得 ARM的一点心得

  • 2011年04月09日 20:00
  • 120KB
  • 下载
收藏助手
不良信息举报
您举报文章:写文档说明书的一点心得
举报原因:
原因补充:

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