怎样写好技术文档

发布日期：2018-04-02 00:40     浏览次数： 次

研发人员有很好的逻辑思维能力，但却常常写不好技术文档，这是一件令人很遗憾的事儿。其原因在于未能理解和贯彻如下四项原则：

第一）不写空话；

第二）文字尽可能简短；

第三）文档的结构应该是模块化的、独立不重复的。力争一个事项在一个地方写明白；

第四）应该采用工程语言进行描述。

对于第四条许多企业采用的是自然语言加数学语言的描述方式。这一般来说是远远不够的，还应该尽可能地学习和掌握统一建模语言。这样就可以大大提高理解的一致性。t

注:统一建模语言已经广泛地应用于软件工程，成为软件需求分析、方案设计、数据库设计的大一统世界语。有许多工具支持统一建模语言。软件工程最著名的CASE工具ROSE就全面应用了统一建模语言。VISIO也提供了统一建模图形库，为非软件专业的人士应用统一建模语言提供了有力的支持。