浅谈技术文档

国内互联网从业者在写文档上是比较欠缺的,尤其是工程师,甚至抵触写文档。据我看来,文档还是很重要的,尤其是企业越来越壮大,系统越来越复杂,文档的规范化和标准化就显得更重要。

不过,反过来说,企业太过臃肿也不利于发展,英特尔公司的安迪◎格鲁夫就曾为公司壮大后渐渐丧失初创时的高效和应变能力而忧虑。吴军在「硅谷之谜」中介绍的“扁平式管理”是解决这个问题的一种方法,它是介于两者之间的一种管理机制。这超出了本文的范围,感兴趣的朋友可以阅读「硅谷之谜」。

回到主题,由于笔者是重度强迫症患者,就助养了「看到糟糕文档就忍不住要骂人」的毛病。但也确实发现一些不好的现象和问题,比如,有时候负责需求的业务人员不了解需求或没有深入的理解,需求文档中甚至有歧义。而程序不能有二义性,等细化需求时,他一脸懵逼的表情,让人很无奈,也很无语,很……

上面的问题,应该跟国内职位分的很细有关:从战略规划,到产品经理,需求分析师,产品设计师,用户体验设计师,系统架构师,到实施者——工程师。如果继续细分,还能分更多,而层级越多,效率就越低,出错也越多。这就需要每个角色在侧重本职工作的同时对其他角色的工作有所了解,至少要知道如何衔接上下过渡部分。如果不能做好这个“偏科”,势必会导致系统在实施过程出现“断层”,或“所得非所想”,结果是「城门失火,殃及池鱼」。

听闻硅谷的工程师大多能够从上到下,掌控每一层环节,无所不通,所以他们的文化是工程师文化,那里的工程师是真正的主人。硅谷的互联网公司的产品经理很少,架构师也很少,工程师“包办”一切。也许这就是为什么国内的程序员被称为“码农”,只会码代码,可不就是码农?

另外一个糟糕问题是,业务人员常常把从客户拿来的原始需求直接放进文档,零零散散,懒得整理,更别说梳理了。为什么不整理,他们不愿意去做这个工作吗?我觉得也未必,我更愿意认为是他们「不会」,他们缺乏足够的信息处理能力。无论在哪行哪业,沟通和写作都是很重要的基本工作能力,是信息处理的基础,尤其是互联网行业。所以,写作能力的重要性可想而知。

其实,平时胡乱写些什么,都可以锻炼写作能力,当能够把一件事情向别人描述清楚时,自己才算真正理解。在写设计文档时深有体会,接到需求时可能云里雾里,但写着写着,思路就像泉涌一样越来越清晰,开发实现也自然水到渠成。

关于写文档,一位硅谷的女神曾说过:“好的技术文档都不是写出来的,而是一遍一遍改出来的。”

At 2017.02.15

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

推荐阅读更多精彩内容