写文档说明书的一点心得

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

本文地址:http://com.8s8s.com/it/it36917.htm