文件恐懼症的分析

2021-08-27 12:54:10 字數 2497 閱讀 7066

大部分開發人員不願意編寫文件,為什麼呢?

1.寫文件需要花費很多時間。

2.不願意暴露自己的思想被別人評判。

3.文件編寫得不好、沒有充分發揮作用。

4.根據實踐經驗,並非不寫文件,專案就幹不下去。有很多客戶也這樣對我講:「我們原來沒有那麼多文件,專案照樣幹,客戶也一樣驗收付款啊!」。

5.如果寫文件,很容易造成文件與實現不一致,文件的價值大大降低。

6.如果寫文件,就不能只寫乙份文件,要寫多份;為了寫多份互相一致的文件,就要做評審,如果評審就要再產生各種評審記錄;每次變更時,要修改多份文件,由此需要花費很多任務作量,從感性認識上,這些工作都會降低專案的開發效率,導致工期的加長。

7.軟體很簡單,不需要寫文件也能記住需求和設計思想。

8.實施cmmi或iso 的企業,很多是為了通過評估、認證而規範,編寫了很多文件,於是有人就抱怨:「cmmi就是文件」,於是文件的名聲就更差了。

9.有很多人確實表達不出來,文字表達能力比較差。

文件與口頭交流是兩種溝通的方式。

1.口頭交流有如下的特點

2.文件具有如下的特點:

綜上所述,如果需要描述的比較嚴密、完備、無二義性,文件作為一種正式的溝通工具遠比口頭交流更加有效。但是文件不能解決所有的溝通問題,需要輔助以口頭交流,二者是互補的,文字不能替代語言,語言也不能替代文字,在軟體開發的過程中尤其是這樣。如果不寫文件,在實踐中確實存在很多問題,比如理解不一致、溝通混亂、返工、無法維護等等。

1.我們需要思考需要文件的目的,根據目的來判斷:

2.比如對於設計文件:

1)假設1:假如你的目的是:為了便於將來維護軟體(注意我這裡說「假如是這個目的」,因為很多公司寫設計文件的目的不僅僅是為了維護),如果是基於這個目的,我們來回答上述的幾個問題:

要不要寫文件?如果不寫文件,如何實現你的目的?需要!

文件是寫給誰看的?維護人員!

文件中的內容應該有什麼?程式的設計思想!核心演算法!類之間的關係!

文件應該由誰來寫?程式設計師!

何時來寫?編碼完成以後!

怎麼寫?可以用工具對**進行逆向工程,然後再由程式設計師新增注釋!

2)假設2:假如你的目的是為了評價設計思想的正確性,如果是基於這個目的,我們來回答上述的幾個問題:

要不要寫文件?如果不寫文件,如何實現你的目的?未必需要寫文件!我們可以讓設計人員在白板上解釋說明其設計思想,大家進行討論和評審!如果不寫文件,則我們需要增加面對面溝通的工作量。

3)假設3:假如你的目的是為了評價設計思想的正確性,並且便於qa進行審計,如果是基於這個目的,我們來回答上述的幾個問題:

要不要寫文件?如果不寫文件,如何實現你的目的?未必需要寫文件!當設計人員在白板上解釋說明設計思想,我們可以邀請qa人員進行實時的監督這個活動的執行,也未必一定要求每次設計思想的評審時,qa都參加,也可以抽查。qa審計的方法有多種:查文件記錄、實際參與、訪談參與的人員。

4)假設4:假如你的目的是為了評價設計思想的正確性,並且為了將來維護軟體,如果是基於這個目的,我們來回答上述的幾個問題:

要不要寫文件?如果不寫文件,如何實現你的目的?需要寫文件!

文件是寫給誰看的?編碼人員,設計專家,維護人員。

文件中的內容應該有什麼?程式的設計思想!核心演算法!類之間的關係!

文件應該由誰來寫?程式設計師!

何時來寫?編碼之前編寫設計文件!

怎麼寫?遵循公司的標準規範或者專案組自己定義的格式編寫設計文件,並進行設計文件的評審。當發生設計思想變更時要修改設計文件,保持設計文件與**的一致性。或者在編碼結束後,要對設計文件和**的一致性進行檢查,修改存在偏差的地方,確保一致性。

3.也可以嘗試定義一些基本的規則,比如:

國慶恐懼症

畢業後才過了乙個國慶 乙個五一,接下來要過的是第三個大節日。今天突然發現自己對它有了恐懼症。且聽我一一道來 恐懼一 國慶前乙個月就開始擔心自己的信用卡會刷爆,節後債務重重 恐懼二 私人空間沒有,國慶前半個月家人就給你安排好了去 心想不去?人家老人家翻臉,好是慚愧。於是乎,硬著頭皮去乎,簡直油中煎熬。...

大齡恐懼症 zz

著作權歸作者所有。對工作的恐懼是臆想,對生活的恐懼才是真實的。公司在經濟學上可以是非常理性的,如果你到 35 歲時跟 25 歲比毫無長進,但你還是如同 25 歲單身時一樣晚上沒事做就加班,你還願意拿 25 歲時的工資,沒理由要炒你呀。真正發生了改變的是你自己的生活,而你的工作只是沒有跟著變而已。同樣...

大資料恐懼症

大資料恐懼症 有許多人認為掌握了越多的資料,越詳細的資料,就有機會通過 大資料 分析法來獲得乙個金礦。但當這些 比你媽還更了解你的時候,你感覺到的不是關懷,而是恐怖。現在的大資料分析,缺乏取樣標準,不代表真實的因果關係。在傳統的統計學裡面,最重要是資料的取樣。比如一種藥物的有效性,需要兩組對比人群,...