淺談技術(shù)文檔

國內(nèi)互聯(lián)網(wǎng)從業(yè)者在寫文檔上是比較欠缺的玄叠,尤其是工程師,甚至抵觸寫文檔拓提。據(jù)我看來读恃,文檔還是很重要的,尤其是企業(yè)越來越壯大崎苗,系統(tǒng)越來越復(fù)雜狐粱,文檔的規(guī)范化和標(biāo)準(zhǔn)化就顯得更重要。

不過胆数,反過來說肌蜻,企業(yè)太過臃腫也不利于發(fā)展,英特爾公司的安迪◎格魯夫就曾為公司壯大后漸漸喪失初創(chuàng)時的高效和應(yīng)變能力而憂慮必尼。吳軍在「硅谷之謎」中介紹的“扁平式管理”是解決這個問題的一種方法蒋搜,它是介于兩者之間的一種管理機制。這超出了本文的范圍判莉,感興趣的朋友可以閱讀「硅谷之謎」豆挽。

回到主題,由于筆者是重度強迫癥患者券盅,就助養(yǎng)了「看到糟糕文檔就忍不住要罵人」的毛病帮哈。但也確實發(fā)現(xiàn)一些不好的現(xiàn)象和問題,比如锰镀,有時候負責(zé)需求的業(yè)務(wù)人員不了解需求或沒有深入的理解娘侍,需求文檔中甚至有歧義。而程序不能有二義性泳炉,等細化需求時憾筏,他一臉懵逼的表情,讓人很無奈花鹅,也很無語氧腰,很……

上面的問題,應(yīng)該跟國內(nèi)職位分的很細有關(guān):從戰(zhàn)略規(guī)劃,到產(chǎn)品經(jīng)理古拴,需求分析師箩帚,產(chǎn)品設(shè)計師,用戶體驗設(shè)計師斤富,系統(tǒng)架構(gòu)師膏潮,到實施者——工程師锻狗。如果繼續(xù)細分满力,還能分更多,而層級越多轻纪,效率就越低油额,出錯也越多。這就需要每個角色在側(cè)重本職工作的同時對其他角色的工作有所了解刻帚,至少要知道如何銜接上下過渡部分潦嘶。如果不能做好這個“偏科”,勢必會導(dǎo)致系統(tǒng)在實施過程出現(xiàn)“斷層”漱贱,或“所得非所想”滋觉,結(jié)果是「城門失火嘱巾,殃及池魚」。

聽聞硅谷的工程師大多能夠從上到下锰蓬,掌控每一層環(huán)節(jié),無所不通眯漩,所以他們的文化是工程師文化芹扭,那里的工程師是真正的主人。硅谷的互聯(lián)網(wǎng)公司的產(chǎn)品經(jīng)理很少赦抖,架構(gòu)師也很少舱卡,工程師“包辦”一切。也許這就是為什么國內(nèi)的程序員被稱為“碼農(nóng)”队萤,只會碼代碼轮锥,可不就是碼農(nóng)?

另外一個糟糕問題是要尔,業(yè)務(wù)人員常常把從客戶拿來的原始需求直接放進文檔舍杜,零零散散,懶得整理盈电,更別說梳理了蝴簇。為什么不整理,他們不愿意去做這個工作嗎匆帚?我覺得也未必熬词,我更愿意認(rèn)為是他們「不會」,他們?nèi)狈ψ銐虻男畔⑻幚砟芰Αo論在哪行哪業(yè)互拾,溝通和寫作都是很重要的基本工作能力歪今,是信息處理的基礎(chǔ),尤其是互聯(lián)網(wǎng)行業(yè)颜矿。所以寄猩,寫作能力的重要性可想而知。

其實骑疆,平時胡亂寫些什么田篇,都可以鍛煉寫作能力,當(dāng)能夠把一件事情向別人描述清楚時箍铭,自己才算真正理解泊柬。在寫設(shè)計文檔時深有體會,接到需求時可能云里霧里诈火,但寫著寫著兽赁,思路就像泉涌一樣越來越清晰,開發(fā)實現(xiàn)也自然水到渠成冷守。

關(guān)于寫文檔刀崖,一位硅谷的女神曾說過:“好的技術(shù)文檔都不是寫出來的,而是一遍一遍改出來的拍摇×燎眨”

At 2017.02.15

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市授翻,隨后出現(xiàn)的幾起案子或悲,更是在濱河造成了極大的恐慌,老刑警劉巖堪唐,帶你破解...
    沈念sama閱讀 216,744評論 6 502
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件巡语,死亡現(xiàn)場離奇詭異,居然都是意外死亡淮菠,警方通過查閱死者的電腦和手機男公,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,505評論 3 392
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來合陵,“玉大人枢赔,你說我怎么就攤上這事∮抵” “怎么了踏拜?”我有些...
    開封第一講書人閱讀 163,105評論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長低剔。 經(jīng)常有香客問我速梗,道長肮塞,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,242評論 1 292
  • 正文 為了忘掉前任姻锁,我火速辦了婚禮枕赵,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘位隶。我一直安慰自己拷窜,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 67,269評論 6 389
  • 文/花漫 我一把揭開白布涧黄。 她就那樣靜靜地躺著篮昧,像睡著了一般。 火紅的嫁衣襯著肌膚如雪弓熏。 梳的紋絲不亂的頭發(fā)上恋谭,一...
    開封第一講書人閱讀 51,215評論 1 299
  • 那天,我揣著相機與錄音挽鞠,去河邊找鬼。 笑死狈孔,一個胖子當(dāng)著我的面吹牛信认,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播均抽,決...
    沈念sama閱讀 40,096評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼嫁赏,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了油挥?” 一聲冷哼從身側(cè)響起潦蝇,我...
    開封第一講書人閱讀 38,939評論 0 274
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎深寥,沒想到半個月后攘乒,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,354評論 1 311
  • 正文 獨居荒郊野嶺守林人離奇死亡惋鹅,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,573評論 2 333
  • 正文 我和宋清朗相戀三年则酝,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片闰集。...
    茶點故事閱讀 39,745評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡沽讹,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出武鲁,到底是詐尸還是另有隱情爽雄,我是刑警寧澤,帶...
    沈念sama閱讀 35,448評論 5 344
  • 正文 年R本政府宣布沐鼠,位于F島的核電站挚瘟,受9級特大地震影響蝇率,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜刽沾,卻給世界環(huán)境...
    茶點故事閱讀 41,048評論 3 327
  • 文/蒙蒙 一本慕、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧侧漓,春花似錦锅尘、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,683評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至纵揍,卻和暖如春顿乒,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背泽谨。 一陣腳步聲響...
    開封第一講書人閱讀 32,838評論 1 269
  • 我被黑心中介騙來泰國打工璧榄, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人吧雹。 一個月前我還...
    沈念sama閱讀 47,776評論 2 369
  • 正文 我出身青樓骨杂,卻偏偏與公主長得像,于是被迫代替她去往敵國和親雄卷。 傳聞我的和親對象是個殘疾皇子搓蚪,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,652評論 2 354

推薦閱讀更多精彩內(nèi)容