如何做出好的文档 (要学习前人的经验,不要闭门造车)

之前一直认为自己Excel文档做的不错,

不久之前,做了一个KT的计划

发现,还是有很多欠缺的地方需要提高


不好的做法

把想要讲的东西一股脑都列出来

(java,JSF,HTML,CSS,java,JSF,HTML,CSS


好的做法:

我们在做文档的时候 ,可以写出KT内容的

大分类

       技术,业务,作业流程,开发环境,工具

小分类

     技术(java,JSF,HTML,CSS)

     作业流程(SRD build UT)

    工具(Eclipse,Excel,Sakura,数据库连接工具)


今后的工作中,需要注意和改善的地方:

 很多文档都有与其类似的文档,我们在做之前,问问有没有类似的文档,

找一个参照来做,已经有的东西(使用过的东西),一般都会不错

(要学习前人的经验,不要闭门造车)

比如上面这种大分类,小分类的写法


猜你喜欢

转载自blog.csdn.net/sxzlc/article/details/77871853