热门标签 | HotTags
当前位置:  开发笔记 > 程序员 > 正文

如何睿智地写文档

每个人都要求别人要写详细的文档,但是自己又讨厌写文档。除了写文档特别麻烦之外,还有就是怕自己的思想精华被别人吸收。文档写起来,可能会比开发代码多几倍的时间,甚至是在一些文采蹩脚的人

每个人都要求别人要写详细的文档,但是自己又讨厌写文档。除了写文档特别麻烦之外,还有就是怕自己的思想精华被别人吸收。文档写起来,可能会比开发代码多几倍的时间,甚至是在一些文采蹩脚的人的脑中,根本无从下手。一些设计文档,代码文档,产品文档,都是项目中的精华。

图片

己所不欲,勿施于人。当你沉下心来写文档的时候,同时你也会要求你的下级或者你身边的同事来一起完善这方面。所以多思考,谁会读你的文档,他们的水平怎么样,能够接受你文档里的东西吗,或者说从哪些方面能够更引人入胜。

图片

其实,从某个角度来讲,代码也是文档,而且严格来说,代码就是技术最高文档的升华提炼。一个程序员如果懂得写详细的文档,那么在由文档去写代码都是事半功倍,因为只是一个把文档翻译成代码的过程。正如你同时会中文和英文,写好中文后,在用一定的时间把中文翻译成英文一样。

图片

对于大公司,特别注重流程化管理。大都数的管理员都是坚信详


推荐阅读
author-avatar
vfh1150403
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有