程序員寫文檔不清晰_一個程序員要具備的基本素質是什麼

1. 本人程序員剛進一家公司，半個月了，現在寫代碼寫不出來怎麼辦

我沒有做過程序員，但稍稍會點簡單的（自學）。我感覺一個成熟的程序是系統工程，初接觸者：無從下配廳敗手個人感覺很正常!

經常在網站上看到公司罵老的離職程序員代碼爛。我認為有二個原因：

1、培顫新入職的員工看不懂，自己不懂但罵罵別人，可以轉嫁風險，讓離職的背鍋，為自己爭取時間過渡或重建。

2、程序代碼易讀性太差，相關伏含說明文檔缺失。雖然實現了功能，但別人接手太難（普遍情況）。新入職除了重建，要麼深入讀懂每個邏輯結構（比重建難，要跟著前一程序員思維走）。

以上二點你大概也清楚什麼意思了。不知道你是維護老代碼呢，還是新項目？

如果是維護老代碼，多看文檔、查資料、了解程序思維，反正有工資拿，也不急。

如果入職的是新項目，說明你技術還不成熟，那就加緊學唄。我個人預計：程序員這行，邊學邊賣的占總比90%

個人見識有限，錯誤難免，重在交流交流!

2. it寫作文檔

1. 為什麼程序員不願寫文檔

其中的原因很多，我自己歸納了幾點：1.怕煩程序員從入門之日起，就在心裡埋藏了一顆編程的種子，認為程序員就是編程序的，就是和計算機打交道的，程序就是程序員的全部。

無論是在編程之前寫文檔，還是在編程之後寫文檔。他們都認為寫文檔很煩人。

1）文檔種類太多。越正規越多。

一想到要寫那麼多的文檔，程序員的頭都要大了。2）文檔寫作要求不低。

有格式要求、內容要求，還需要畫各種流程圖、示意圖、關系圖、界面圖和填寫各種表格說明，以及要收集各種資料。雖然沒有技術含量，但是要花的時間比編程序多，而且也不一定能寫好。

3）在正規的開發公司中一般一個變更就要編寫一系列的變更文檔。當不斷變更時，只有最後的變更文檔是最重要的。

當我們不知道當前是不是最後一個文檔時，我們就不願意寫可能被後面的文檔替代的文檔。4）當寫了文檔之後，就會不斷有使用文檔的人來詢問細節，這些詢問往往會讓人崩潰。

這是因為很難寫出讓每個人都提不出問題的文檔。2.沒空在很多情況下，程序員都處於一種「時間緊、任務重」狀態。鄭首穗

在急於得出編程結果的驅使下，程序員一心撲在編程上，恨不得一分鍾一個變化，哪有心思和時間先把文檔寫好再去編程呢？即使他們擁有先把程序編出來，然後再補寫文檔的想法，但是一旦他們完成一段程序之後，就會立即撲向第二段程序。如此下來，編寫文檔只能放在項目開發的後期了。

你要是真的寫文檔，那寫文檔的時間早已將編程時間給擠佔了，你的編程工作就完不成了。3.沒有用文檔的重要性其實對不同對象是不一樣的。

如果你說文檔沒有用，立即會有人用唾沫把你淹死，他們立即會搬出哪個哪個說文檔是重要的，文檔是不可缺的。唯獨不敢說「我自己認為文檔是重要的」。

這也反過來說明文檔的有用性程喊卜度對不同人是不一樣的。對於程序員來說，只要能把程序編出來就行了。

很多程序員不寫文檔照樣編出程序來，在他們的觀念中文檔不寫也罷。如果按文檔編程序，那就要確保文檔的正確性、不可更改性。

而實際上，文檔不如編程快，編程不如變化快，不斷變化的需求和代碼讓文檔如同一張過時的廢紙一樣。在現實中，有的文檔變成了項目開發後的總結，對開發本身並不起作用，只是保留一個存在的形式，以應付各種各樣規范的需要。

在這種情況下，文檔沒有任何實用價值，所以即使程序員寫了，也沒有什麼作用。尤其是項目投產後，幾經升級，最初的文檔早已和現實的情況對不上號了，文檔更新和系統的一致性更是難於控制。

4.沒好處既然認為編程序才是正道，那麼程序員寫文檔就是一種額外和輔助的工作，做了就做了，對於程序員來說沒有任何好處。當然，文檔的好處更多地體現在軟體公司、單位、軟體用戶、後續程序員身上，它是一種「前人栽樹，後人乘涼」的好事。

所以程序員不願意寫文檔。文檔有多麼重要呢？有人把它上升到「程序員頭腦的拷貝」的高度，有的人甚至說，程序員走了後，只要有了文檔，軟體公司可以再招新人，公司照樣運轉起來。

如此說來，天性聰明的程序員會把文檔寫得清清楚楚嗎？5.不會寫從寫作本身來看，芹慶寫好一篇文檔不是一件容易的事。文檔有文檔的格式和寫作要求。

現在的人只喜歡動嘴說事，沒有多少人在平時會動筆寫字，更不用說寫文章了。所以，寫文檔從理論上來說也是需要學習和訓練的，需要在平時進行寫作積累。

當要求一些程序員寫文檔的時候，他往往會回答你：「怎麼寫呀？我不會。」你不會寫可以不怪你，你不去學，反而理直氣壯地說不會，則是你的不對了。

難道那些會寫文檔的人都是「獃子」嗎？難道他們不懂幹活辛苦的道理嗎？當一個男子向一個自己喜歡的女子示愛，需要用情書來表白的時候，難道他不會寫情書嗎？即使他不會寫，他也一定會克服千難萬險把情書寫出來的，這是他的主觀使然。如果程序員主觀上想寫文檔，怎麼會怕煩？怎麼會怕沒空？怎麼會怕文檔沒有用？怎麼會怕不會寫？這些怕其實都是借口。

真正優秀的程序員應該不單是編程的高手，同時也應該是寫文檔的高手。程序員真正不喜歡寫文檔的原因是：文檔是給別人看的，不是給自己看的。

如果要使程序員喜歡寫文檔，那就要提高程序員的意識和境界，或者要給寫文檔的程序員以獎勵。而靠制度、管理讓程序員去寫文檔只能是一種職業上的弊端。

當有一天寫文檔也成為一個專業化的崗位，程序員和文檔人員分開時，程序員就會一心一意看文檔寫代碼，文檔員就會以此為職業，一心一意寫文檔拿工資。我們將不再為此進行討論。

這種分工一定是未來的趨勢。一些大的公司或管理規范的公司都已經有這樣的分工了。

只是很多中小軟體公司或企事業單位里的IT部門還沒有專業化到如此程度。程序員不喜歡寫文檔也許說明他們不願意承擔太多的角色吧。

不管怎麼說，作為一個程序員（尤其想成為優秀程序員）一定要學會寫文檔，一定要學會欣賞文檔。無論你是否喜歡，你都應該可以在文檔的各種問題面前可進可退。

可以這樣說，那些既不會寫文檔，又不會欣賞文檔的程序員是沒有資格說「我就不喜歡寫文檔」這種話的。

2. IT文檔工程師有什麼要求

我就是文檔工程師。就技術要求上說

1.需要你對文字的表達能力，畢竟多是要你自己「寫」文檔，而且針對對象不同，表達的方式不同。寫作技巧，文字細節等，需要揣摩。主要是簡介明了，准確易懂，有針對，不羅嗦。

2.需要你能比較熟練操作MS 工具，主要是word，寫文檔主要靠這個，其次還有excel和PPT，較之word少。不是說非要精通，很多東西都是在實際工作中慢慢學來的。

3.需要你對公司產品有個了解，比如產品系統架構，主要的工作流程，各個組件的功能和原理。由於寫文檔很直接跟這些相關，所以要盡快掌握。

4.要不斷自我學習。雖然文檔工程師不像，研發和測試工程師那麼累，但是也要不斷學習。學習英語，因為可能需要翻譯。學習IT行業的一些基本知識，買幾本書，手頭翻翻。學習產品相關的軟體使用，比如linux指令等。如果涉及程序代碼的，就要學習那些編程語言了，不過也只是架構上的，不需要你看懂每一行語句。

差不多就這些了。任何職業都要有自己的能力和興趣的融入，才能工作開心，生活開心。祝你好運

3. 我是學it的（想在網上寫小說怎麼寫

第一種是先把自己的文存在word文檔里在相應的貼吧發文

例如言情小說可以在言情小說吧里發文不過這種一般都是寫的好玩的

第二種是在小說網上

比較好的就是小說閱讀網起點晉江

如果是校園的小說的話可以去聚星不過聚星很卡

如果文筆比較淡比較成熟的話可以去花火

不過這種方法一般要通過審核才可以發表第一種可以自己發表

第二種方式比較考文筆

如果ll不想審核的話可以去貼吧發不過吧友的回復也是一種審核吧

第二種如果文筆比較拖沓的話就很容易功虧一簣了可能寫了一大堆但通不過審核╮（╯▽╰）╭

但這兩種都最好要把文文存在word文檔里雖然小說網一般可以作家存稿但還是文檔里保險一些

4. 知名企業招聘網路工程師要求

網路工程師每個公司和任職要求不一樣，一般分為初級、中級和高級，初級任職要求相對較低，任職要求一般為：計算機及相關專業大專以上學歷；熟悉相關系統；熟悉網路協議，對網路有一定了解；具有一定的英語閱讀能力和英語基礎；了解相關伺服器。

中級和高級要求工作經驗兩年以上，任職要求也較高具備網路維護或相關工作經驗，掌握各種網路環境搭建（LAN/WAN），具備較強的技術基礎；掌握數據網路基礎知識；具備較強的網路維護和故障處理能力，熟悉網路測試工具；熟悉網路安全、主機安全相關知識，能熟練配置主流的防火牆，等等，不過每個公司的職位要求還得視該公司具體職位要求為准。

5. 為什麼程序員不願寫文檔

無論是在編程之前寫文檔，還是在編程之後寫文檔。他們都認為寫文檔很煩人。

1）文檔種類太多。越正規越多。

一想到要寫那麼多的文檔，程序員的頭都要大了。2）文檔寫作要求不低。

3）在正規的開發公司中一般一個變更就要編寫一系列的變更文檔。當不斷變更時，只有最後的變更文檔是最重要的。

這是因為很難寫出讓每個人都提不出問題的文檔。2.沒空在很多情況下，程序員都處於一種「時間緊、任務重」狀態。

你要是真的寫文檔，那寫文檔的時間早已將編程時間給擠佔了，你的編程工作就完不成了。3.沒有用文檔的重要性其實對不同對象是不一樣的。

這也反過來說明文檔的有用性程度對不同人是不一樣的。對於程序員來說，只要能把程序編出來就行了。

很多程序員不寫文檔照樣編出程序來，在他們的觀念中文檔不寫也罷。如果按文檔編程序，那就要確保文檔的正確性、不可更改性。

如此說來，天性聰明的程序員會把文檔寫得清清楚楚嗎？5.不會寫從寫作本身來看，寫好一篇文檔不是一件容易的事。文檔有文檔的格式和寫作要求。

真正優秀的程序員應該不單是編程的高手，同時也應該是寫文檔的高手。程序員真正不喜歡寫文檔的原因是：文檔是給別人看的，不是給自己看的。

這種分工一定是未來的趨勢。一些大的公司或管理規范的公司都已經有這樣的分工了。

只是很多中小軟體公司或企事業單位里的IT部門還沒有專業化到如此程度。程序員不喜歡寫文檔也許說明他們不願意承擔太多的角色吧。

可以這樣說，那些既不會寫文檔，又不會欣賞文檔的程序員是沒有資格說「我就不喜歡寫文檔」這種話的。

6. 如何才能寫出好的產品文檔

一般來說，產品文檔分為產品需求文檔和產品使用文檔兩種。產品需求文檔主要面向的是產品的開發、設計者，期望是產品的實際開發人員了解產品的細節，讓開發完成的產品達到前期設計需求的預期；產品使用文檔面向的主要是使用者，使其通過產品文檔掌握產品的功能使用，也就是我們常說的產品使用幫助；如果不搞清楚文檔面向的對象，往往寫出來達不到預想的效果。類似這樣專業的文檔文案，其實是有一定共通性的；掌握這類文案的寫作技巧，尤其對我們IT從業人員來說，是一項非常不錯的技能。筆者從業這兩年，跟此類文檔打過不少交道，在這里跟各位分享一些經驗。

1、對象要清楚

開篇就提到了，清楚文檔面向的對象的重要性。對於不同的對象，必須使用不同的寫作思路來對待，盡可能的站在對方的角度去思考。他需要看到什麼？什麼內容對他有用？我如何闡述給他？對於產品設計人員，他所需要了解的是產品的樣式、界面、交互等情況，對於實際編碼人員，他則偏重於產品的可實現性，你的內容則需要偏注產品的功能細節和內部處理。所以，文檔面向的對象決定了文檔的功能和內容。確定文檔面向的對象才能做到有的放矢。

2、條理要清晰

文檔的條理清晰不僅讓你的文檔看起來比較順暢，更讓閱讀者能夠很清楚的理解。所以，下筆之前就應當知道自己的文檔內容大致分為哪幾個大的模塊、模塊下又細分了多少個子模塊，然後在大綱的基礎上，再進行詳細的內容填充。筆者之前的經驗，往往在文檔下筆之前認真思考了好幾天，總希望在下筆之前就希望把所有的問題都想清楚。這對於寫作者來說，是一件不好的舉動。其實，東西在腦子里轉悠，不如在紙上來的直觀。大綱列出來之後，然後再來反復的添加、修改，比你按筆不動要來的有效率得多。對於寫作來說，最難的也是開始。

3、邏輯要嚴謹

產品類的文檔不同於平常我們書寫的文檔類型。對於內容敘述的嚴謹性要求非常嚴格。因為你的文檔不單單是一個你對這個項目、產品的理解，它更是需要做為一個協作的載體讓其他的同事同時使用，更可能成為其他同事工作方向的指引。因此，嚴謹是必須的。所以，在滿足了文檔條理清楚的前提下，仔細斟酌、思考文檔可能會出現歧義、漏缺的部分，反復修改文檔成為了一項必須的工作。在大家協調工作的背景下，你一個人不可能將所有的問題都考慮清楚。所以往往出現同事指出你文檔中存在的毛病和漏洞。但是你還是應當在前期多做一些考慮，將問題盡量減少。

4、用詞要專業

專業的用詞不當可以幫助你提升文檔的專業度，更可以幫助你提升效率，減少重復和不必要的溝通成本。既然是行業那就需要行業標准，使用專業的行業術語是一種職業化的表現，這樣既可以很快和同事達成共識，又讓別人覺得你很專業。我想，同事之前這樣的協作才是有效率的。當然，對於新手來說，如何掌握專業的用詞，這就需要平時多看多讀了。多了解小眾的博客，多認識一些前輩和朋友，無論是對寫作還是對工作的認識，都是很有幫助的。

5、格式要規范

對於一個IT行業從業人員來講，規范化、流程化的工作模式是非常重要的。對於需要經他人手的文檔、或者需要進行存檔的文檔來說，格式的規范與否是一個衡量你專業化程度高低的重要衡量標准。當然，說到這個規范，你在第一次寫作之前就應該了解這個規范是一個什麼樣的規范。是行業規范？還是公司內部的規范？這取決於你所在公司或所從事項目的情況。對於大公司，你所要做的就是找之前前輩們寫過的同類文檔進行拜讀，了解這些規范。對於小公司或者新創的項目，之前沒有過同類產品文檔的情況。你所要做的就是沿用標准規范再加上項目特點，盡可能細致的書寫。相信，經過你的努力的，你寫的文檔將會成為該類文檔的案例，成為規范。

其實無論是產品需求文檔（PRD）、產品策劃書還是商業計劃書，其實都是需要我們下功夫仔細研究的。畢竟中國互聯網發展才十幾年，很多細節都還不是很專業。對於一個會思考的互聯網人，武裝自己的頭腦，豐富自己的技能才能找到更好的職業發展。

3. 一個程序員要具備的基本素質是什麼

團隊精神和協作能力：
把它作為基本素質，並不是不重要，恰恰相反，這是程序員應該具備的最基本的，也是最重要的安身立命之本。
文檔習慣：
作為代碼程序員，30％的工作時間寫技術文檔是很正常的，而作為高級程序員和系統分析員，這個比例還要高很多。缺乏文檔，一個軟體系統就缺乏生命力，在未來的查錯，升級以及模塊的復用時就都會遇到極大的麻煩。
規范化，標准化的代碼編寫習慣：
作為一些外國知名軟體公司的規矩，代碼的變數命名，代碼內注釋格式，甚至嵌套中行縮進的長度和函數間的空行數字都有明確規定，良好的編寫習慣，不但有助於代碼的移植和糾錯，也有助於不同技術人員之間的協作。
需求理解能力：
作為程序員需要評估該模塊在系統運營中所處的環境，將要受到的負荷壓力以及各種潛在的危險和惡意攻擊的可能性。就這一點，一個成熟的程序員至少需要2到3年的項目研發和跟蹤經驗才有可能有心得。
復用性，模塊化思維能力：
復用性設計，模塊化思維就是要程序員在完成任何一個功能模塊或函數的時候，要多想一些，不要局限在完成當前任務的簡單思路上，想想看該模塊是否可以脫離這個系統存在，是否可以通過簡單的修改參數的方式在其他系統和應用環境下直接引用，這樣就能極大避免重復性的開發工作。
測試習慣：
軟體研發作為一項工程而言，一個很重要的特點就是問題發現的越早，解決的代價就越低，程序員在每段代碼，每個子模塊完成後進行認真的測試，就可以盡量將一些潛在的問題最早的發現和解決，這樣對整體系統建設的效率和可靠性就有了最大的保證。
學習和總結的能力：
善於學習，對於任何職業而言，都是前進所必需的動力，對於程序員，這種要求就更加高了。但是學習也要找對目標，一些小coding fans們，他們也津津樂道於他們的學習能力，一會學會了asp，一會兒學會了php，一會兒學會了jsp，他們把這個作為炫耀的資本，盲目的追逐一些膚淺的，表面的東西和名詞，做網路程序不懂通訊傳輸協議，做應用程序不懂中斷向量處理，這樣的技術人員，不管掌握了多少所謂的新語言，永遠不會有質的提高。

4. 哎！做程序員一年了，感覺有的時候看不懂開發文檔，感覺很枯燥老想著看視頻入門我這種的是不是可以轉行了

現在的你不是考慮轉不轉行的時候既然你已經堅持了一年那最起碼基本的能力還是有的你夜深人靜的時候好好想想吧任何行業起步都難難道你轉行，頭一年能樂得輕松自在嘛？編程工作第一年甚至第二年都是很西辛苦很痛苦的，哥們跟你說實話我也做了一年程序員今年幹了別的行業才發現根本沒我當初想的那麼好也是從頭開始和程序員頭一年沒差別所以我明年決定回到開發工作再干幾年賺點資金再考慮搞別的

5. 程序員怎樣規范編寫介面文檔

規范的事情當然要有專業的工具。推薦使用的是docway寫介面文檔，方便保存和共享，支持導出PDF MARKDOWN，支持團隊項目管理。

一些剛開始寫介面文檔的服務端同學，很容易按著代碼的思路去編寫介面文檔，這讓客戶端同學或者是服務對接方技術人員經常吐槽，看不懂介面文檔。這篇文章提供一個常規介面文檔的編寫方法，給大家參考。

一、請求參數

1. 請求方法

用於獲取數據

POST

用於更新數據，可與PUT互換，語義上PUT支持冪等

用於新增數據，可與POST互換，語義上PUT支持冪等

DELETE

用於刪除數據

其他

其他的請求方法在一般的介面中很少使用。如：PATCH HEAD OPTIONS

2. URL

url表示了介面的請求路徑。路徑中可以包含參數，稱為地址參數，如**/user/{id}**，其中id作為一個參數。

3. HTTP Header

HTTP Header用於此次請求的基礎信息，在介面文檔中以K-V方式展示，其中Content-Type則是一個非常必要的header，它描述的請求體的數據類型。

常用的content-type：

application/x-www-form-urlencoded

請求參數使用「&」符號連接。

application/json

內容為json格式

application/xml

內容為xml格式

multipart/form-data

內容為多個數據組成，有分隔符隔開

4. HTTP Body

描述http body，依賴於body中具體的數據類型。如果body中的數據是對象類型。則需要描述對象中欄位的名稱、類型、長度、不能為空、默認值、說明。以表格的方式來表達最好。

示例：

五、介面工具

推薦使用的是http://docway.net（以前叫小幺雞）寫介面文檔，方便保存和共享，支持導出PDF MARKDOWN，支持團隊項目管理。

6. 作為程序員如何書寫技術文檔

按自己的喜好去寫,沒有具體的格式,不過要寫名程序的用途,代碼的函數使用方法,變數的意義等內容

7. C#初級程序員，怎麼快速提高技能呢做技術牛人

1：團隊精神和協作能力
把它作為基本素質，並不是不重要，恰恰相反，這是程序員應該具備的最基本的，也是最重要的安身立命之本。把高水平程序員說成獨行俠的都是在囈語，任何個人的力量都是有限的，即便如linus這樣的天才，也需要通過組成強大的團隊來創造奇跡，那些遍布全球的為linux寫核心的高手們，沒有協作精神是不可想像的。獨行俠可以作一些賺錢的小軟體發點小財，但是一旦進入一些大系統的研發團隊，進入商業化和產品化的開發任務，缺乏這種素質的人就完全不合格了。

2：文檔習慣
說高水平程序員從來不寫文檔的肯定是乳臭未乾的毛孩子，良好的文檔是正規研發流程中非常重要的環節，作為代碼程序員，30％的工作時間寫技術文檔是很正常的，而作為高級程序員和系統分析員，這個比例還要高很多。缺乏文檔，一個軟體系統就缺乏生命力，在未來的查錯，升級以及模塊的復用時就都會遇到極大的麻煩。

3：規范化，標准化的代碼編寫習慣
作為一些外國知名軟體公司的規矩，代碼的變數命名，代碼內注釋格式，甚至嵌套中行縮進的長度和函數間的空行數字都有明確規定，良好的編寫習慣，不但有助於代碼的移植和糾錯，也有助於不同技術人員之間的協作。
有些coding fans叫囂高水平程序員寫的代碼旁人從來看不懂，這種叫囂只能證明他們自己壓根不配自稱程序員。代碼具有良好的可讀性，是程序員基本的素質需求。
再看看整個linux的搭建，沒有規范化和標准化的代碼習慣，全球的研發協作是絕對不可想像的。
4：需求理解能力
程序員需要理解一個模塊的需求，很多小朋友寫程序往往只關注一個功能需求，他們把性能指標全部歸結到硬體，操作系統和開發環境上，而忽視了本身代碼的性能考慮，有人曾經放言說寫一個廣告交換程序很簡單，這種人從來不知道在百萬甚至千萬數量級的訪問情況下的性能指標是如何實現的，對於這樣的程序員，你給他深藍那套系統，他也做不出太極鏈的並訪能力。性能需求指標中，穩定性，並訪支撐能力以及安全性都很重要，作為程序員需要評估該模塊在系統運營中所處的環境，將要受到的負荷壓力以及各種潛在的危險和惡意攻擊的可能性。就這一點，一個成熟的程序員至少需要2到3年的項目研發和跟蹤經驗才有可能有心得。

5：復用性，模塊化思維能力
經常可以聽到一些程序員有這樣的抱怨，寫了幾年程序，變成了熟練工，每天都是重復寫一些沒有任何新意的代碼，這其實是中國軟體人才最大浪費的地方，一些重復性工作變成了熟練程序員的主要工作，而這些，其實是完全可以避免的。
復用性設計，模塊化思維就是要程序員在完成任何一個功能模塊或函數的時候，要多想一些，不要局限在完成當前任務的簡單思路上，想想看該模塊是否可以脫離這個系統存在，是否可以通過簡單的修改參數的方式在其他系統和應用環境下直接引用，這樣就能極大避免重復性的開發工作，如果一個軟體研發單位和工作組能夠在每一次研發過程中都考慮到這些問題，那麼程序員就不會在重復性的工作中耽誤太多時間，就會有更多時間和精力投入到創新的代碼工作中去。
一些好的程序模塊代碼，即便是70年代寫成的，拿到現在放到一些系統裡面作為功能模塊都能適合的很好，而現在我看到的是，很多小公司軟體一升級或改進就動輒全部代碼重寫，大部分重復性工作無謂的浪費了時間和精力。

6：測試習慣
作為一些商業化正規化的開發而言，專職的測試工程師是不可少的，但是並不是說有了專職的測試工程師程序員就可以不進行自測；軟體研發作為一項工程而言，一個很重要的特點就是問題發現的越早，解決的代價就越低，程序員在每段代碼，每個子模塊完成後進行認真的測試，就可以盡量將一些潛在的問題最早的發現和解決，這樣對整體系統建設的效率和可靠性就有了最大的保證。
測試工作實際上需要考慮兩方面，一方面是正常調用的測試，也就是看程序是否能在正常調用下完成基本功能，這是最基本的測試職責，可惜在很多公司這成了唯一的測試任務，實際上還差的遠那；第二方面就是異常調用的測試，比如高壓力負荷下的穩定性測試，用戶潛在的異常輸入情況下的測試，整體系統局部故障情況下該模塊受影響狀況的測試，頻發的異常請求阻塞資源時的模塊穩定測試等等。當然並不是程序員要對自己的每段代碼都需要進行這種完整測試，但是程序員必須清醒認識自己的代碼任務在整體項目中的地位和各種性能需求，有針對性的進行相關測試並盡早發現和解決問題，當然這需要上面提到的需求理解能力。

7：學習和總結的能力
程序員是人才很容易被淘汰，很容易落伍的職業，因為一種技術可能僅僅在三兩年內具有領先性，程序員如果想安身立命，就必須不斷跟進新的技術，學習新的技能。
善於學習，對於任何職業而言，都是前進所必需的動力，對於程序員，這種要求就更加高了。但是學習也要找對目標，一些小coding fans們，他們也津津樂道於他們的學習能力，一會學會了asp，一會兒學會了php，一會兒學會了jsp，他們把這個作為炫耀的資本，盲目的追逐一些膚淺的，表面的東西和名詞，做網路程序不懂通訊傳輸協議，做應用程序不懂中斷向量處理，這樣的技術人員，不管掌握了多少所謂的新語言，永遠不會有質的提高。
善於總結，也是學習能力的一種體現，每次完成一個研發任務，完成一段代碼，都應當有目的的跟蹤該程序的應用狀況和用戶反饋，隨時總結，找到自己的不足，這樣逐步提高，一個程序員才可能成長起來。
一個不具備成長性的程序員，即便眼前看是個高手，建議也不要選用，因為他落伍的時候馬上就到了。
具備以上全部素質的人，應當說是夠格的程序員了，請注意以上的各種素質都不是由IQ決定的，也不是大學某些課本里可以學習到的，需要的僅僅是程序員對自己工作的認識，是一種意識上的問題。

那麼作為高級程序員，以至於系統分析員，也就是對於一個程序項目的設計者而言，除了應該具備上述全部素質之外，還需要具備以下素質：

第一，需求分析能力
對於程序員而言，理解需求就可以完成合格的代碼，但是對於研發項目的組織和管理者，他們不但要理解客戶需求，更多時候還要自行制定一些需求，為什麼這么說呢？
一般而言，進行研發任務，也許是客戶提出需求，也許是市場和營銷部門提出的需求，這時候對於研發部門，他們看到的不是一個完整的需求，通常而言，該需求僅僅是一些功能上的要求，或者更正規些，可能獲得一個完整的用戶視圖；但是這都不夠，因為客戶由於非技術因素多一些，他們可能很難提出完整和清晰，或者說專業性的性能需求，但是對於項目組織者和規劃者，他必須能夠清醒認識到這些需求的存在並在完成需求分析報告的時候適當的提出，同時要完整和清晰的體現在設計說明書裡面，以便於程序員編碼時不會失去這些准則。
程序設計者必須正確理解用戶需求所處的環境，並針對性做出需求的分析，舉例而言，同樣一個軟體通過ASP租用方式發布和通過License方式發布，性能需求可能就是有區別的，前者強調的是更好的支撐能力和穩定性，而後者則可能更強調在各種平台下的普適性和安裝使用的簡捷性。

第二，項目設計方法和流程處理能力
程序設計者必須能夠掌握不少於兩到三種的項目設計方法（比如自頂至下的設計方法，比如快速原型法等等），並能夠根據項目需求和資源搭配來選擇合適的設計方法進行項目的整體設計。設計方法上選擇不當，就會耽誤研發周期，浪費研發資源，甚至影響研發效果。
一個程序設計者還需要把很多功夫用在流程圖的設計和處理上，他需要做數據流圖以確立數據詞典；他需要加工邏輯流圖以形成整體的系統處理流程。一個流程有問題的系統，就算代碼多漂亮，每個模塊多精緻，也不會成為一個好的系統。當然，做好流程分析並選擇好項目設計方法，都需要在需求分析能力上具有足夠的把握。

第三，復用設計和模塊化分解能力
這個似乎又是老調重談，前面基本素質上不是已經說明了這個問題嗎？
作為一個從事模塊任務的程序員，他需要對他所面對的特定功能模塊的復用性進行考慮，而作為一個系統分析人員，他要面對的問題復雜的多，需要對整體系統按照一種模塊化的分析能力分解為很多可復用的功能模塊和函數，並針對每一模塊形成一個獨立的設計需求。舉個例子，好比是汽車生產，最早每輛汽車都是獨立安裝的，每個部件都是量身定做的，但是後來不一樣了，機器化大生產了，一個汽車廠開始通過流水線來生產汽車，獨立部件開始具有一定的復用性，在後來標准化成為大趨勢，不同型號，品牌甚至不同廠商的汽車部件也可以進行方便的換裝和升級，這時候，汽車生產的效率達到最大化。軟體工程也是同樣的道理，一個成熟的軟體行業，在一些相關項目和系統中，不同的部件是可以隨意換裝的，比如微軟的許多桌面軟體，在很多操作模塊（如打開文件，保存文件等等）都是復用的同一套功能模塊，而這些介面又通過一些類庫提供給了桌面應用程序開發者方便掛接，這就是復用化的模塊設計明顯的一個佐證。
將一個大型的，錯綜復雜的應用系統分解成一些相對獨立的，具有高度復用性的，並能僅僅依靠幾個參數完成數據聯系的模塊組合，是作為高級程序員和系統分析員一項最重要的工作，合適的項目設計方法，清晰的流程圖，是實現這一目標的重要保證。

第四，整體項目評估能力
作為系統設計人員，必須能夠從全局出發，對項目又整體的清醒認識，比如公司的資源配置是否合理和到位，比如工程進度安排是否能最大化體現效率又不至於無法按期完成。評估項目整體和各個模塊的工作量，評估項目所需的資源，評估項目可能遇到的困難，都需要大量的經驗積累，換言之，這是一種不斷總結的累計才能達到的境界。在西方一些軟體系統設計的帶頭人都是很年長的，比如4，50歲，甚至更老，他們在編碼方面已經遠遠不如年輕人那樣活絡，但是就項目評估而言，他們幾十年的經驗積累就是最重要和寶貴的財富。中國缺這么一代程序員，主要還不是缺那種年紀的程序員，而是那種年紀的程序員基本上都是研究單位作出來的，都不是從專業的產品化軟體研發作出來的，他們沒有能積累那種產品化研發的經驗，這也是沒有辦法的事情。
第五，團隊組織管理能力
完成一個項目工程，需要團隊的齊心協力，作為項目設計者或研發的主管人，就應當有能力最大化發揮團隊的整體力量，技術管理由於其專業性質，不大同於一般的人事管理，因為這裡面設計了一些技術性的指標和因素。
首先是工作的量化，沒有量化就很難做到合適的績效考核，而程序量化又不是簡單的代碼行數可以計算的，因此要求技術管理人員需要能真正評估一個模塊的復雜性和工作量。
其次是對團隊協作模式的調整，一般而言，程序開發的協作通常分為小組進行，小組有主程序員方式的，也有民主方式的，根據程序員之間的能力水平差距，以及根據項目研發的需求，選擇合適的組隊方式，並能將責權和成員的工作任務緊密結合，這樣才能最大發揮組隊的效率。
一個代碼水平高的人，未必能成為一個合格的項目研發主管，這方面的能力欠缺往往是容易被忽視的。

綜上可以看到，作為一個主管研發的負責人，一個項目設計者，所需要具備的素質和能力並不是程序代碼編寫的能力，當然一般情況下，一個程序員通過不斷的總結提高達到了這種素質的時候，他所具有的代碼編寫能力也已經相當不簡單了，但是請注意這裡面的因果關系，一個高水平的項目設計者通常已經是代碼編寫相當優秀的人了，但是並不是一個代碼相當優秀的程序員就可以勝任項目設計的工作，這裡面存在的也不是智商和課本的問題，還是在於一個程序員在積累經驗，逐步提升的時候沒有意識到應當思考哪方面的東西，沒有有意識的就項目的組織和復用設計進行揣摩，沒有經常性的文檔習慣和總結習慣，不改變這些，我們的合格的項目設計者還是非常欠缺。

另外，為防止有無聊的人和我較真，補充一點，本文針對目標是作商業化的軟體項目和工程，那些科研機構的編程高手，比如演算法高手，比如圖象處理高手，他們的工作是研究課題而非直接完成商業軟體（當然最終間接成為商業產品，比如微軟研究院在作的研究課題），因此他們強調的素質可能是另外的東西，這些人（專家），並不能說是程序員，不能用程序員的標准去衡量。

最後補充一點東西，一個軟體項目研發的設計流程是怎樣的呢？以通常標準的設計方法為例，（不過筆者喜歡快速原型法）。

第一個步驟是市場調研，技術和市場要結合才能體現最大價值。

第二個步驟是需求分析，這個階段需要出三樣東西，用戶視圖，數據詞典和用戶操作手冊。用戶視圖是該軟體用戶（包括終端用戶和管理用戶）所能看到的頁面樣式，這裡麵包含了很多操作方面的流程和條件。數據詞典是指明數據邏輯關系並加以整理的東東，完成了數據詞典，資料庫的設計就完成了一半多。用戶操作手冊是指明了操作流程的說明書。請注意，用戶操作流程和用戶視圖是由需求決定的，因此應該在軟體設計之前完成，完成這些，就為程序研發提供了約束和准繩，很遺憾太多公司都不是這樣做的，因果顛倒，順序不分，開發工作和實際需求往往因此產生隔閡脫節的現象。
需求分析，除了以上工作，筆者以為作為項目設計者應當完整的做出項目的性能需求說明書，因為往往性能需求只有懂技術的人才可能理解，這就需要技術專家和需求方（客戶或公司市場部門）能夠有真正的溝通和了解。

第三個步驟是概要設計，將系統功能模塊初步劃分，並給出合理的研發流程和資源要求。作為快速原型設計方法，完成概要設計就可以進入編碼階段了，通常採用這種方法是因為涉及的研發任務屬於新領域，技術主管人員一上來無法給出明確的詳細設計說明書，但是並不是說詳細設計說明書不重要，事實上快速原型法在完成原型代碼後，根據評測結果和經驗教訓的總結，還要重新進行詳細設計的步驟。
第四個步驟是詳細設計，這是考驗技術專家設計思維的重要關卡，詳細設計說明書應當把具體的模塊以最『干凈』的方式(黑箱結構）提供給編碼者，使得系統整體模塊化達到最大；一份好的詳細設計說明書，可以使編碼的復雜性減低到最低，實際上，嚴格的講詳細設計說明書應當把每個函數的每個參數的定義都精精細細的提供出來，從需求分析到概要設計到完成詳細設計說明書，一個軟體項目就應當說完成了一半了。換言之，一個大型軟體系統在完成了一半的時候，其實還沒有開始一行代碼工作。那些把作軟體的程序員簡單理解為寫代碼的，就從根子上犯了錯誤了。

第五個步驟是編碼，在規范化的研發流程中，編碼工作在整個項目流程里最多不會超過1/2，通常在1/3的時間，所謂磨刀不誤砍柴功，設計過程完成的好，編碼效率就會極大提高，編碼時不同模塊之間的進度協調和協作是最需要小心的，也許一個小模塊的問題就可能影響了整體進度，讓很多程序員因此被迫停下工作等待，這種問題在很多研發過程中都出現過。編碼時的相互溝通和應急的解決手段都是相當重要的，對於程序員而言，bug永遠存在，你必須永遠面對這個問題，大名鼎鼎的微軟，可曾有連續三個月不發補丁的時候嗎？從來沒有！

第六個步驟是測試
測試有很多種：按照測試執行方，可以分為內部測試和外部測試；按照測試范圍，可以分為模塊測試和整體聯調；按照測試條件，可以分為正常操作情況測試和異常情況測試；按照測試的輸入范圍，可以分為全覆蓋測試和抽樣測試。以上都很好理解，不再解釋。
總之，測試同樣是項目研發中一個相當重要的步驟，對於一個大型軟體，3個月到1年的外部測試都是正常的，因為永遠都會又不可預料的問題存在。
完成測試後，完成驗收並完成最後的一些幫助文檔，整體項目才算告一段落，當然日後少不了升級，修補等等工作，只要不是想通過一錘子買賣騙錢，就要不停的跟蹤軟體的運營狀況並持續修補升級，知道這個軟體被徹底淘汰為止。

寫這些步驟算不上賣弄什麼，因為實話講我手邊是一本《軟體工程》，在大學里這是計算機專業的必修課程，但是我知道很多程序員似乎從來都只是熱衷於什麼《30天精通VC》之類的，他們有些和我一樣游擊隊出身，沒有正規學過這個專業，還有一些則早就在混夠學分後就把這些真正有用的東西還給了老師。

網上現在也很浮躁，一些coding fans亂嚷嚷，混淆視聽，實際上真正的技術專家很少在網上亂發帖子的，如筆者這樣不知天高地厚的，其實實在是算不上什麼高手，只不過看不慣這種對技術，對程序員的誤解和胡說，只好挺身而出，做撥亂反正之言，也希望那些還沉迷於一些錯誤人士的coding fans們能認真想想，走到正途上，畢竟那些聰明的頭腦還遠遠沒有發揮應有的價值。

8. 程序員在上班時，允不允許大量的看說明文檔來幫助寫程序

程序員日常開發工作，基本是上離不開閱讀文檔，這也是很多程序員喜歡兩個顯示器的原因。

項目方面

技術方面
是不是很多人都認為，如果在開發過程中，還要不斷地翻技術文檔，說明他的開發能力不扎實。其實不是這樣的。

首先IT行業技術升級換代的速度太快，當我們大多數公司還在用Java8的時候，Java11都已經出來了。如果非得要程序員熟知每一個類、每一個方法，是很不現實的。

很多時候我們只需要了解有這么一個東西，作用是干什麼的，具體的細節可以在用的時候再去翻文檔，比如方法名字是什麼？參數有幾個，都是什麼類型的？

所以我們都習慣至少兩個電腦屏幕，一個屏幕寫代碼，一個屏幕看文檔；如果豪一些的話，再加一個屏幕展示日誌信息。

看文檔的屏幕要買豎屏！

我們團隊
我這幾年也帶過幾個團隊，對於每個團隊成員，我對他們的要求是：實現需求的前提下，最好能對所用的技術有一定的了解，千萬不要從網上抄過來一段代碼就用，這樣是很危險的行為。所以鼓勵大家多找一些資料，最好是閱讀框架的官方文檔。

現在的團隊，我已經這樣要求了：代碼寫累了，或者覺得自己沒有狀態寫代碼，可以找點兒自己有興趣的技術文檔學習學習，這個技術甚至是可以跟現在的項目沒有關系的。

首先，我不是程序員，我是一個設計工作者，不過我來說一下我的觀點：很多人以為程序員像電影里的一樣，啪啪啪幾下鍵盤，屏幕數據颼颼的變，其實真實情況是程序員寫代碼就像學生寫作文，也會遇到不會的詞語跟修辭手法，那這個時候就要停下來想一想，查一查，看看例子是怎樣寫的怎樣用的，寫錯了還要劃掉（刪掉）再來，至於這個大量不大量看的情況，如果這個是個新手，那肯定是可以的，那如果是個老手，還需要大量時間查說明文檔，那就說明這個項目肯定不會小，不是一兩天能做完的，那一個用月做單位的項目，用一個天做單位的時間來查文檔，不過分吧！程序員也是人，不是因為他的工作高端，就覺得這個人萬能，他也會當機，要吃飯，要休息，也會忘記一些東西，所以請各位多多體諒，能一起工作實屬不易，感恩2018，謝謝。

這個問題怎麼說呢，開發過程中會遇到各種各樣的問題，沒有一個人是全能的，也沒有人可以絕對的說自己在整個項目中不會遇到一點問題，不去查東西，自己大腦里的東西完全可以讓我把這個項目測測底底的做完，並且沒有任何bug。

上班的時間，也沒有老闆或者誰在後面一直看著你去做東西，大家都挺忙。文檔是幹嘛的，文檔本身就是用來看的，甚至很多項目開始之前，總監都會讓你去搜集一些這個項目可能會遇到的bug，可能會用到的效果，盡量在之前找到比較好用的插件，這樣會節省很多時間，自己如果寫代碼的話不可能百分百的確定沒有人和bug，但插件不一樣很多插件都是前輩通過很長時間慢慢完善出來的插件，所以很多人才會用。所以你提問的可以肯定的回答你允許。

說個我遇到的2個真事吧，

第一個，公司找的外包公司寫項目程序，已經要交付了，發現有幾個功能沒做，產品經理和開發那邊都找我，我一個搞運維的又不懂，只能讓他們去對開發文檔，我也就順便看了看，開發文檔中明確的寫明怎麼做，然後就讓他們就重新按開發文檔繼續寫，

另一個，由於歷史原因業務系統處於託管狀態，只有部分參考文檔可用，開發那邊只能按當前已有文檔進行開發參考，開發那邊也一直在根據現有相關文檔進行開發，杯具的是這幫子不仔細看，有問題總想著我能直接給他們答案，我也只是會用而已，開發我還真搞不來，然後和他們一起看開發文檔，加密演算法部分給她們指出後，問題解決了。

所以我覺得，開發團隊在開發中很有必要閱讀開發文檔，這可以避免繞圈子，也會清楚開發文檔中提供的內容。

程序員上班的主要工作就是看說明文檔，根據說明文檔編碼。如果實在沒有說明文檔，有時還得親自披掛上陣寫說明文檔。

寫介面的有API文檔，寫通訊協議的有協議欄位說明文檔，寫資料庫的有資料庫規範文檔，

總之任何一個大公司文檔扮演的一個至關重要的問題，因為形不成文檔，公司管理就會陷入混亂不堪的局面，當某個核心員工離職後，下一個接盤的程序員會丈二和尚摸不著頭腦，一頭霧水，邊填坑邊罵娘，有了文檔就可以看文檔結合代碼，了解其中模塊邏輯以及結構，包括哪些坑不能踩等等好處。有些公司會專門有文檔工程師這個職位來專門負責整理各種文檔，並且保存在伺服器上。

好的文檔都是程序員等人智慧的結晶，是一盞指路明燈，是一條通往光明的道路。程序員不能看說明文檔等於在黑暗裡摸爬滾打，有了說明文檔才迎來了黎明的曙光。

先說觀點，我認為看文檔沒什麼問題，但是「大量」這個程度很難衡量，按照需要看文檔是個非常重要的事情。
需要花費時間的情況不需要花費大量時間的情況小結
在工作中閱讀文檔其實也是工作內容的一部分，而且現在大多數互聯網公司都靠KPI進行考核，平時就算你把時間都用來看文檔沒關系，最後KPI沒完成一樣會被公司淘汰。所以公司不會阻攔你花費時間看文檔，最多你老闆會提醒你浪費這么多時間看文檔而沒有實際的產出會對你年終考核造成影響罷了。

題主對文檔的定義不是很明確
第一個是需求說明文檔
這個是在開發過程中必不可少的文檔，只有清楚了開發需求，程序員高效率的開發，程序員一天的工作時間並不是都是在寫代碼，而是在看文檔，了解需求，理清思路，只有什麼都清楚了，寫代碼或許只要十幾分鍾。

再者對於一個項目新人來說不看文檔了解需求，沒人給你從頭到尾的在講一遍需求，你不看文檔自己發揮？進入項目是和別人共同開發，你不肯能不顧及之前的代碼規范。
第二個是開發文檔
就拿微信開發來說，微信開發不是每個程序員必須會的東西，但是用到了怎麼辦，還不是去看他們的開發文檔，只有將開發文檔思路理清楚了，才可以進行下一步開發。
第三個是API文檔
在前後端分離的開發模式中API文檔是必不可少的文檔。不看API不知道數據是什麼樣。也就是不可能順利的和後端進行結合。

兄dei，假設你是程序員，你在寫程序時，旁邊會有人守著你嗎？

假設你不是程序員，你在做本職工作時，旁邊會有人守著你看你怎麼做事嗎？

答案肯定是沒有的。誰會閑著招個人去監督你，看你用什麼方式去完成給你的任務。

現在不管是大公司還是小公司，沒有人會在意你怎麼去完成你的工作，給你的任務，在很多時候，大家只關注結果。如果說有干預，最多隻是實現的方式。像寫程序，假設有個功能是即時通訊相關的，這種自己寫需要的時間成本投入較高，那麼很多公司就會選擇採用市面上比較穩定的第三方平台。這算一種實現方式的干預。但是在接入的過程中，不會有人去管你是通過閱讀第三方SDK文檔，還是谷歌搜出來的，最後能達到預期效果就ok了

所以，其實你看不看大量文檔，沒有人會在乎，關鍵是你自己，建議自己寫東西時，不要一味的復制粘貼，要有自己的想法。太依賴文檔對於自己成長很不利

當然允許看文檔。

要知道，隨便哪個類庫，都有無數的類和方法，每個方法又有若干參數，鬼知道它們都是什麼意思，誰的腦子能記得那麼多內容。別說是人家提供的類庫，就是自己寫的代碼，過一段時間也不記得什麼意思了。沒有注釋和文檔，怎麼看懂代碼？

如果沒有需求分析文檔，程序員怎麼理解正在開發的這個軟體的基本業務流程？

如果沒有架構設計文檔，程序員怎麼理解軟體各個功能模塊之間的功能與業務邏輯？

如果沒有介面文檔，那麼多類和方法，都怎麼調用，會返回什麼值，難道靠猜？

……

在日常開發工作中，不僅允許看文檔，還會強迫你寫文檔。如果你寫的文檔別人看不懂，別怪領導罵你不認真。文檔對於軟體開發的重要性是不言而喻的。

還有一個秘密告訴你，那些經常寫文檔的程序員，要比不寫文檔的程序員工資更高。

真的！！！

迎娶白富美，從會寫文檔開始！

毫無疑問是的。

對於程序員來說，在實際工作中進行代碼編寫和項目開發時，是離不開各種各樣的文檔的。文檔包括：

不允許看說明文檔，這基本上只會出現在面試或者考試中，為了考察程序員自身的編碼能力，才要求脫離參考資料，利用自身的知識和技術來完成。

當然了，程序員工作中也不能只看文檔，要是花費大量時間通讀不必要的文檔，工作可就做不完了。

導航:首頁 > 程序命令 > 程序員寫文檔不清晰