如何睿智地写文档

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

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

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

对于大公司,特别注重流程化管理。大都数的管理员都是坚信详细的文档就是流程化的保证。不存在有个大拿把控一切,不存在有人说离开了这个技术大拿,产品就造不出来,公司就无法运营下去,这是错误的思想。所以管控优秀的文档,人没了继续招人,公司就像铁打的营盘,员工就是流水,一波一波的换来换去,公司永不倒。

当然,对于个人来讲,如果你不想让你的思想暴露出来,同时上司又要求你规范文档,那么你完全可以写得含蓄一些,代码里不要写注释,把自己的逻辑表达的婉转一些。对于一个负责人的程序员,可能对你的要求是这样的。

编写的代码文档非常标准规范(可以不写注释),需要你的头文件和源文件按照代码规范来写,优秀的命名规则,折叠伸缩有序,段落合理,代码优雅,那么我觉得要不要写注释没那么重要。

简单清晰的架构设计文档。你可以用简单的流程图,或者思维导图,不要求你画很多框框,但是可能你需要言简意赅。

编写给别人看的代码,比如SDK上的api函数名。为读者和客户考虑,把你珍贵的时间花在让他更加容易阅读的事情上。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,014评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,796评论 3 386
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,484评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,830评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,946评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,114评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,182评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,927评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,369评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,678评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,832评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,533评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,166评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,885评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,128评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,659评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,738评论 2 351

推荐阅读更多精彩内容