文档编写的重要性

        陈近南说，为什么要反清复明?还不是为了金钱和女人。
        这句话我一直在引用。当然我自己并非是这种想法。我只是希望让一些朋友能够明白，其实做一件事情的目的可能并不是想象中的那样，而是因为另外的一件事情。例如俱乐部搞一场活动。从下面看，可能只是为了活动的本身内容而已，从上面看，则是为了搞好俱乐部。角度不同，想到的也不同。
        其实不同也无所谓，大家都乐在其中就行了。
        
        这些话我一直都在大脑里面想。今天和一个师妹聊了很久，我试图让她明白一个道理，很开心的是她最终还是理解了。看来我还没有老。突然感叹自己，老了。这两年多来已经不知道参加了多少次的各种类型比赛。有些人觉得我很风光，但是我的内心确实觉得自己很失败，始终没有突破自己设立的一个高度。在学校的时间越来越短了，我也不能再花这些时间去参加比赛了。但是每次比赛的过程都是让我个人能力提升的过程。各方面，心理承受能力、编码能力、演讲能力，还有就是产品包装能力。我10月份参加IBM比赛所交的作品就是我把我所学到的所有技能都运用到去包装的一个产品。我很满意我这次的作品。能否得奖其次，完成这作品所带给我的快感就让我无比的舒服。我有空的时候也会情不自禁的拿出来自我欣赏一下，像个画家看自己画的作品一样。如果没有前面的锻炼，我现在估计什么都不是了。
        产品包装最重要的可能就是文档的编写。用户界面涉及一个实现模型和心智模型。如果是技术人员，一般做出来的用户界面都会倾向于实现模型。但是实现模型往往会难以让用户接受，用户会问，怎么这麽难用。而后者则能让用户满意。其实编写文档也是一样。
        第一件事情就是要明白看这份文档的对象是谁、位于开发周期的什么位置。项目方案书给谁看，需求文档给谁看。明确了对象后就基本上了解了应该怎么写，应该写什么内容。举个简单的例子。很多人会在需求文档里面写自己用到了什么技术，这技术如何如何。需求文档主要的对象应该是用户、和系统开发人员，在写需求文档的时候应该设计方案还没有出来。系统的设计人员应该按照需求文档来思考采用什么技术设计。
        第二件事情就是要明确什么图什么表是应该在什么文档出现的。例如小型项目里面，数据库设计应该出现在概要设计中，用例图应该出现在需求分析中，类图应该出现在详细设计中。我见过好多例子都是搞乱套了。而网上提供的一些文档模板也是乱套了。
        还有其他的事情还是明天写吧。今天帮别人搞定一个样条线的程序，很开心。

转载于:https://www.cnblogs.com/zjblue/archive/2005/11/12/274502.html