【工作总结】编写文档经验总结ppt模版课件.docVIP

编写文档经验总结【IT168 技术文章】 　　自从编程脱离了刀耕火种的时代以来，文档就是程序的重要组成部分。而且各种名目的文档无所不有。对于写代码出身的人来说，往往相当不重视文档的编写。但是不幸的是，作为软件支持的重要组成部分，很多时候，文档却能影响软件产品的成败。 　　笔者一个月写帮助文档的经历实在是感触颇多，总结出来希望能给大家一些帮助。入门水平，特为没有写过文档而又计划写文档而准备。 　　如无特别说明，下面的文档特指CHM类型的帮助文档。不是Java的那种可以生成的API帮助文档，而是指用户手册。与Sandcastle等不是一回事。 一．人员配备 　　做事第一步，就是要选人。无数的书已经介绍过选正确的人的重要性，这里就不赘述了。大约需要三种实际做事儿的人。 1.文档编写者：实际编写文档内容的人。如果资金和时间都比较充足可以由专门的人员来做。能做出高品质的文档。但是这种情况在广大的中小项目中比较少。多种情况下，编写文档的人会是程序的设计或开发大员。他们熟悉项目，省去了培训的成本，但是工作性质的不同决定了他们一开始写出的文档品质相当的不高。对项目的过度熟悉让他们潜意识地觉得文档没有什么内容好写。 2.文档审查：负责文档的内容正确性，用语准确、简洁。说白了就是英语文档的语法、词汇检查。同时也许要负责文档基本样式的定制和进度的安排。不要以为英文文档才需要，就是中文文档，不同人写出来的