淺談技術(shù)文檔

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

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

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

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

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

另外一個(gè)糟糕問(wèn)題是,業(yè)務(wù)人員常常把從客戶拿來(lái)的原始需求直接放進(jìn)文檔,零零散散,懶得整理,更別說(shuō)梳理了。為什么不整理,他們不愿意去做這個(gè)工作嗎?我覺(jué)得也未必,我更愿意認(rèn)為是他們「不會(huì)」,他們?nèi)狈ψ銐虻男畔⑻幚砟芰?。無(wú)論在哪行哪業(yè),溝通和寫(xiě)作都是很重要的基本工作能力,是信息處理的基礎(chǔ),尤其是互聯(lián)網(wǎng)行業(yè)。所以,寫(xiě)作能力的重要性可想而知。

其實(shí),平時(shí)胡亂寫(xiě)些什么,都可以鍛煉寫(xiě)作能力,當(dāng)能夠把一件事情向別人描述清楚時(shí),自己才算真正理解。在寫(xiě)設(shè)計(jì)文檔時(shí)深有體會(huì),接到需求時(shí)可能云里霧里,但寫(xiě)著寫(xiě)著,思路就像泉涌一樣越來(lái)越清晰,開(kāi)發(fā)實(shí)現(xiàn)也自然水到渠成。

關(guān)于寫(xiě)文檔,一位硅谷的女神曾說(shuō)過(guò):“好的技術(shù)文檔都不是寫(xiě)出來(lái)的,而是一遍一遍改出來(lái)的。”

At 2017.02.15

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • Android 自定義View的各種姿勢(shì)1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 179,039評(píng)論 25 709
  • 文/缺硯一方 01 國(guó)慶,于終日忙碌于工作的上班族而言,總有幾分期待,看身邊的很多人都早早便安排了行程,回家、旅行...
    缺硯一方閱讀 2,457評(píng)論 6 19
  • 早上剛起來(lái),就看到窗外在下雨,很喜歡雨天,下雨的時(shí)候總能想到一些以前發(fā)生的事,比如,初中體育課下著小雨,我們?cè)诨@球...
    如果你是草莓那我是牛油果閱讀 304評(píng)論 0 0
  • 從小就喜歡要求完美,可我們都不是很完美的人,但還是要不顧一切的接受不完美的自己。 生活在一個(gè)足夠大...
    一硯清陌閱讀 696評(píng)論 0 10
  • 1.為何需要maven 確定框架之后,會(huì)去對(duì)應(yīng)官網(wǎng)下載對(duì)應(yīng)的jar,有可能出現(xiàn)以下問(wèn)題 jar包沖突 jar臃腫(...
    敘憶閱讀 762評(píng)論 0 0

友情鏈接更多精彩內(nèi)容