您能否推薦一本用於爲軟件工程師編寫文檔的最佳書籍？

Question

我想編寫一個文件，例如：

• ，部署過程
• 軟件結構
• DB結構

但我不是以英語爲母語的人，所以我想提高自己的英語寫作文件。你能推薦一本好書爲軟件工程師寫文檔嗎？

Answer 1

我想在技術文檔系統的或常用的表達式學習從一本書

有一招地道的學習專業英語。

它的工作原理是這樣的。

1. 閱讀慣用的技術英語。

2. 複製你讀到的內容。

作爲母語爲英語的人，讓我強調一些經常被忽視的東西。英語語法非常靈活，美國學校不教美國英語語法。沒有太多的美國英語語法書籍來提供對美國英語的系統理解，因爲 - 坦率地說 - 美國英語沒有系統。英語是從其他語言借來的。美國英語涉及更多借用更多不同種族背景的人。這意味着很多規則和很多規則的例外。太多例外意味着 - 實際上 - 沒有規則。

讓語言演化比試圖發明（並強制執行）規則更容易。

學習美式英語的最好方法是閱讀美式英語。

如果您想學習編寫「部署過程」，請執行此操作。

1. 查找軟件產品的部署過程。

2. 複製它，進行更改。

如果要編寫「軟件結構」或「數據庫結構」的描述，請執行此操作。

1. 找到你喜歡和理解的軟件的描述。

2. 複製它，進行更改。

這幾乎就是我們在美國教英語的方式。如果它適用於愚蠢的老美國人，它應該適用於任何人。

Answer 2

最好的軟件文檔technical writing book：

Writing Software Documentation (2nd ed.)

最好的一般書：

Technical Communication (11th ed.)

Answer 3

它不會傷害讀這本小書，這有助於學會簡潔：

http://en.wikipedia.org/wiki/The_Elements_of_Style