最佳实践：文档标准

Question

这是问题，我需要找到/想到我们团队的文档标准。我们有几个需求，我们需要 需求文档 ， 技术文档 - 项目<的文档标准/ strong>和代码样式文档 - 面向开发人员，它将涵盖开发人员应如何命名，并组织项目的代码（他应该使用区域吗？应该如何命名？等等），我知道它可能因项目而异，但也许有某种标准。目前，每个开发人员都按照他的想象编写它，但这并不是很好，因为它不一致，并且具有不同的样式等。

我很好奇你/你公司是怎么做到的。也许有一些标准。

应该怎么样？它应包含哪些内容？等。

BTW我们使用.NET技术。

Answer 1

几年前Brad Abrams在他的博客上发布了一个内部微软编码指南的例子：http://blogs.msdn.com/brada/articles/361363.aspx

另请参阅Microsoft开发类库的设计指南http://msdn.microsoft.com/en-us/library/ms229042.aspx

Answer 2

这是一本非常好的书：Microsoft Manual of Style for Technical Publications。

Answer 3

我遇到了同样的问题，并转向IEEE寻找一些标准。我找到了以下内容，我还没有读过，但似乎很相关：

一般文件标准

• IEEE Standard for Information Technology--Systems Design--Software Design Descriptions
• IEEE Systems and software engineering -- Software life cycle processes
• IEEE IEEE Trial-Use Standard--Adoption of ISO/IEC TR 15026-1:2010 Systems and Software Engineering--Systems and Software Assurance--Part 1: Concepts and Vocabulary

除此之外，www.codingthearchitecture.com

还有一个很好的概述

编码样式标准

除了上面提到的非常好的“微软开发类库的设计指南”之外，在Linux Kernel Coding Style Guidelines中还有一些非常好的参数，尽管这里给出的例子都是在C中。