您能否为软件工程师撰写最佳书籍？

Question

我想写一份文件，例如：

• 部署程序
• 软件结构
• 数据库结构

但我不是英语母语，所以我想用英文写作文件。你能推荐一本好书来为软件工程师编写文档吗？

Answer 1

软件文档中最好的technical writing book：

<强> Writing Software Documentation (2nd ed.)

最好的通用书：

<强> Technical Communication (11th ed.)

Answer 2

  

我想从书中的技术文档系统或经常使用的表达中学习

学习惯用的技术英语有一个技巧。

就像这样。

1. 阅读惯用技术英语。

2. 复制您阅读的内容。

作为母语为英语的人，我要强调一些经常被忽视的事情。英语语法非常灵活，美国学校不会教授美国英语语法。没有多少美国英语语法书籍可以提供对美国英语的系统理解，因为 - 坦率地说 - 美国英语没有系统。英语借用其他语言。美国英语涉及更多具有不同种族背景的人的借贷。这意味着许多规则和许多规则例外。太多的例外意味着 - 实际上 - 没有规则。

让语言发展比试图发明（和执行）规则更容易。

学习美式英语的最佳方式是阅读美式英语。

如果您想学习编写“部署程序”，请执行此操作。

1. 查找软件产品的部署过程。

2. 复制，进行更改。

如果要编写“软件结构”或“数据库结构”的描述，请执行此操作。

1. 查找您喜欢和理解的软件说明。

2. 复制，进行更改。

这几乎就是我们在美国教英语的方式。如果它适用于愚蠢的老美国人，它应该适用于任何人。

Answer 3

阅读这本有助于学习简洁的小书不会有害：

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