软件开发的201个原则
上QQ阅读APP看本书,新人免费读10天
设备和账号都新为新人

原则32 使用文档标准

USE DOCUMENTATION STANDARDS

如果你的项目、组织或客户要求遵循一套文档标准,那就要遵循它。无论如何,永远不要抱怨标准,认为这是不需要的。所有我熟悉的标准,无论是政府标准还是商业标准,都提供了组织和内容方面的指导。

创新!即遵循标准,同时理智地执行。无论标准怎么规定,把你知道的应有的内容都包含进去。这意味着用清晰的语言来编写,意味着添加额外的有意义的组织层级。如果你的文档没有被要求遵循某个标准,至少应使用检查清单来检查是否有重大的遗漏。IEEE发布的文档标准,是我所知道的最广泛的可用软件文档标准之一。

IEEE Computer Society,Software Engineering Standards Collection,Washington,D,C.: IEEE Computer Society Press,1993.