技術文檔怎麼寫

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

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

② it技術文檔怎麼寫才高大上

使用書面語，避免口語化，名詞通篇一致，語法正確。
專有名詞應有必要的解釋glossary。
必要時須有清晰完整的配圖及注釋。
使用清晰的文檔結構、標題、標號。word文檔應使用大綱。
包含明確的文檔版本管理記錄、reference。

③ 技術文檔寫作幾點建議

任何新技術，新方法的文檔和書記都大致分為兩類。

第一類是官方手冊，是白皮書，對該技術有最權威的解釋權，由技術提出者維護。此類文檔一般只是枯燥的記錄功能條目，其作用等價於字典（沒人會拿著字典從第一頁看到最後一頁看完）。優點是給該技術提供了一致的解釋權，該技術對於使用者有根基可循，缺點是相對枯燥不適合用來技術傳播。

第二類是技術使用者根據自己經驗寫的類似於「最佳實踐」的材料，裡面融合和作者個人看法，相對比較生動，組織也很吸引人。優點是有想法，適合用於技術傳播，缺點是比較主觀，個別觀點未見得准確或者說有偏見。

當兩部分材料結合在一起就能發揮最大的作用。

下面分享幾點技術文檔寫作建議（中英文），通用於上述兩種。

1. 應盡量避免使用「你」，「We can」，「You should」這樣的稱謂，取而代之應該使用「用戶」，"Users"這種更通用的稱謂。

2. 盡量多使用忽略動作發出者的被動句子。

3. 在引用代碼和腳本時候應使用特殊字體標出，必要時還原其在開發環境中存在時的色彩。

4. 文中特殊名詞應該用黑體或者粗體標識出來，以提醒讀者此處是一個專有名詞，而非寬泛的敘述。

5. 當在文中用中文提出一個行業名詞時，盡量在後面用英文寫出其原文，讓已知此概念讀者方面對照，並告知不知此概念讀者此概念非你所造而是有出處。

6. 盡量少用「可惜」，"unfortunately"這種帶有主觀情緒的形容詞和副詞。

7. Bullet或者Numeric列條目時，動作要使用原型動詞引導的祈使句，比如 Create a new account.

④ java web 技術文檔怎麼寫

如果只是要描述這個程序的結構與使用的到的技術相對來說比較簡單點..
你如果代碼進行MVC的這種模式的 你可以進行分層描寫，各層用到了什麼技術框架..還有使用到框架中的某些功能，列舉一個類似功能清單之類的介紹文檔就可以了

⑤ 前端開發的技術文檔怎麼寫

可以從項目背景，功能模塊，目錄結構，介面列表來寫，還可以配合jsdoc自動生成各個js文件的詳細文檔

⑥ 技術文檔的技術文檔的要求

技術文檔要符合以下要求：
1.針對性
文檔編制以前應分清讀者對象，按不同的類型、不同層次的讀者，決定怎樣適應他們的需要。
① 對於面向管理人員和用戶的文檔，不應像開發文檔(面向軟體開發人員)那樣過多地使用軟體的專業術語。 難以避免使用的詞彙，應在文檔中添加詞彙表，進行解釋。
② 開發文檔使用的專業詞彙未被廣泛認知的，應添加註釋進行說明。
③ 縮寫詞未被廣泛認知的，應在其後跟上完整的拼寫。
2.正確性
① 沒有錯字，漏字。
② 文檔間引用關系正確。
③ 文檔細節(Title/History)正確。
3.准確性
① 意思表達准確清晰，沒有二義性。
② 正確使用標點符號，避免產生歧義。
4.完整性
① 意思表達完整，能找到主語、謂語、賓語，沒有省略主語，特別是謂語。
② 一句話中不能出現幾個動詞一個賓語的現象。
③ 不遺漏要求和必需的信息。
5.簡潔性
① 盡量不要採用較長的句子來描述，無法避免時，應注意使用正確的標點符號。
② 簡潔明了，不累贅冗餘，每個意思只在文檔中表達一次。
③ 每個陳述語句，只表達一個意思。
④ 力求簡明，如有可能，配以適當的圖表，以增強其清晰性。
6.統一性
① 統一採用專業術語和項目規定的術語集。
② 同一個意思和名稱，前後描述的用語要一致。
③ 文檔前後使用的字體要統一。
④ 同一課題若干文檔內容應該協調一致，沒有矛盾。
7.易讀性
① 文字描述要通俗易懂。
② 前後文關聯詞使用恰當。
③ 文檔變更內容用其他顏色與上個版本區別開來。
④ 測試步驟要採用列表的方式，用1)、2)、3)…等數字序號標注。

⑦ 項目技術文檔要求寫哪些內容

要寫立項目的、意義、開發設計路線、開發階段性報告、開發技術總結等。

⑧ 請問軟體項目的技術開發文檔都要寫些什麼呢，具體要求是什麼呢，要寫多少文檔呢

要寫的文檔種類有很多；根據不同的軟體系統，每種文檔內容的內容、格式和要求又有所不同。
1）文檔的種類可以參考任何一本《軟體工程》書籍。大致包括：用戶需求調研報告、需求分析、概要設計、用戶手冊、測試計劃、詳細設計、詳細編碼文檔、測試報告等等
2）很多類型的軟體文檔都有國標(GB)或行業標准（例如國際軍用標記——GJB)規定的格式，具體情況可查詢相關標准。

⑨ 主要技術文件目錄及來源 怎麼寫

主要技術文件目錄及來源格式：

項目名稱：

項目負責人：

項目單位：

聯系電話：

辦公：

手機：

起止時間：

批准金額：

填表日期：

內蒙古醫學院科技處制二零零七年十二月。

一、項目摘要。

二、項目研究執行情況概述。

三、項目研究工作主要進展及所取得成果。

四、成果轉化情況，取得的經濟、社會效益（附證明材料）。

五、國內外學術合作交流及人才培養情況。

六、存在問題、建議及其它需要說明的情況。

七、下一步的打算與研究計劃。

八、經費使用情況九、項目負責人簽字及審核意見附表1內蒙古醫學院科研項目研究成果目錄（欄目不夠可自行增加）註：

1、「成果類型」欄，分為「專著/期刊論文/會議論文/專利/獲獎/其他」六類，請歸類集中填寫並單獨編號；

2、「成果說明」欄，用於填寫如刊物名、獲獎類別、級別等必要的說明和便於其他人查詢的信息等；

3、「備注」欄，用於說明成果是否標注「內蒙古醫學院重大(青年)科研項目基金資助」及項目批准號等。

(9)技術文檔怎麼寫擴展閱讀：

資信部分包括公司資質，公司情況介紹等一系列內容，同時也是招標文件要求提供的其他文件等相關內容，包括公司的業績和各種證件、報告等。

技術部分包括工程的描述、設計和施工方案等技術方案，工程量清單、人員配置、圖紙、表格等和技術相關的資料。

商務部分包括投標報價說明，投標總價，主要材料價格表和合同條件（通用和專用）等。

技術文件的修改必須按級、按各職能部門的業務分管范圍執行。

技術文件修改前，負責修改部門要提出修改理由及具體內容，交有關領導審批。

⑩ 招標技術文件如何寫

做為技術人員，主要准備兩個文件。一是你的技術詢價書；二是貨物需求一覽表及技術規格，就是我們俗稱的第八章。另外可能還會要求技術人員確認招標信息中的一些明細。不讓不合格的投標人鑽空子，需要在第八章的廢標項裡面多費些心思了。對於你認為是重大偏離的技術要點一定要在文字上有所體現。同時注意招標法的相關准則，不要落下讓人告的口實。