程序員開發文檔怎麼寫

① 請高手指教，一個java WEB項目的開發文檔要怎麼寫，讓別的程序員一看就明白這個項目的框架是怎麼工作的。

你這個問題問得不太合理，開發文檔要寫很多東西，而你要讓程序員看懂這個項目的話，只要寫交互圖就可以了，至於項目的框架式怎麼工作的，只要告訴程序員是什麼框架就可以了，程序員應該會使用框架

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

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

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

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

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

一、請求參數

1. 請求方法

• GET

用於獲取數據

• POST

用於更新數據，可與PUT互換，語義上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，支持團隊項目管理。

④ 我是個編程的自學者，想當程序員不知道公司寫文檔是什麼意思知道的情給我解釋一下,還有具體是怎樣工作的

以鄙人在軟體公司工作的經驗與你分享一下吧。
我們平時做項目，一般有一半以上時間都在管理文檔，包括基本設計書，詳細設計書，靜態樣式書，各種UML建模圖，單體測試書，系統測試數，結合測試書，DB設計書，DB腳本，以及各種工具類管理文檔，如資源文件管理，VBA管理等等，這還不包括項目前期的需求建設書，項目中期與客戶交流的反饋書，項目後期的BUG管理書，以及貫穿項目的工程進度表和版本控制書。當然你的代碼資源（包括注釋，圖片，腳本等）也屬於文檔，需要統一管理。
對於追求簡短快的團隊，未必會太重視文檔的組織與管理，但是一定要相信文檔看似浪費時間，其實無形中提高了很大的效率，而且在未來的開發提供了寶貴的參考資料。屬於團隊積累的一種。

⑤ java程序員需要些什麼文檔

我很少寫文檔，懶得寫，除非項目有要求

對於文檔這個東西簡單談一下

1. 做項目之前就有文檔

   這個是可遇不可求的，現在做的項目很多都是臨時突然說要做的，什麼需求都沒有，只能靠程序員自己去發現，項目經理的要求，客戶的臨時需求（這個比較痛苦，他們有時候根本就不知道要什麼，所以必須寫好文檔，跟客戶談好，不然又要變的時候，你就痛苦了）

   如果項目一開始就有文檔，當然也可能是你自己寫的，也可能是其他人寫好的，有些公司有人專門負責寫，需求分檔，項目分析文檔，項目結構文檔，資料庫文檔等等，不過之後可能需要你寫測試文檔，這個就沒有聽說過誰幫你做了，但是更多的情況也是不用寫，就幾個功能，自己和測試人員測測就算了，也有可能需要寫使用文檔，這個看情況了

2. 做項目之前沒有文檔

   如果項目緊張，根本就不會寫任何文檔，但是當項目結束的時候，你又沒有項目做，項目精靈可能就讓你寫寫文檔打發打發時間，

文檔對於公司來說是很重要的，但是對於個人的話，就要看情況，如果你做了很多項目，其實什麼文檔也不需要，你大體上都知道這個項目就做什麼用的，怎麼架構的，那些代碼是什麼意思(你的編程習慣很好的情況下)，所以很多公司都會要求程序員寫文檔，不然你走的時候，別的人怎麼接受，讓別人理解你的思想是很痛苦的，每個人的思想都是不一樣的

⑥ java面試官問有沒有寫過文檔（面試java程序員）,我想知道寫文檔是指什麼,是設計文檔還是需求文檔還是其他

一般大點的公司需求文檔還是不需要你去編寫的，不過需要開發人員協同討論與審批，
一般開發人員要寫的是 概要設計文檔，和詳細設計文檔之類的
至於步驟要看公司而定，有的是開發完成後才去補寫這樣的文檔，有的是在開發前就需要
將文檔寫好，然後按照文檔來開發。

⑦ 安卓開發程序員需要自己寫開發文檔嗎

這個要看公司需求，如果需要還是要具備寫開發文檔的能力，軟體需求文檔格式的標准寫法引言 、編寫目的、闡明開發本軟體的目的、項目背景、標識待開發軟體產品的名稱、代碼、列出本項目的任務提出者、項目負責人、系統分析員、系統設計員、程序設計員、程序員、資料員以及與本項目開展。

⑧ android app開發文檔怎麼寫

：軟體需求文檔格式的標准寫法 1．引言 1．1 編寫目的 · 闡明開發本軟體的目的； 1．2 項目背景 · 標識待開發軟體產品的名稱、代碼； · 列出本項目的任務提出者、項目負責人、系統分析員、系統設計員、程序設計員、程序員、資料員以及與本項目開展

⑨ 程序員開發文檔怎麼寫

去下載一個開發文檔模板按照寫就可以了