【问题标题】：Best Practice: Documentation Standards [closed]最佳实践：文档标准 [关闭]
【发布时间】：2009-11-22 11:44:00
【问题描述】：

这是问题所在，我需要为我们的团队找到/考虑文档标准。我们有几个需求，我们需要需求文档、技术文档的文档标准 - 项目和 代码样式文档 - 供开发人员使用，这将涵盖开发人员应如何命名和组织项目代码（他应该使用区域吗？命名看起来应该如何？等等。 )，我知道它可能因项目而异，但也许有某种标准。目前每个开发者都按照自己的想象来写，那不是很好，因为它是不一致的，并且有不同的风格等等。

我很好奇您/您的公司是如何做到这一点的。也许有某种标准。

它应该是什么样子？它应该包括哪些内容？等等。

顺便说一句，我们使用 .NET 技术。

【问题讨论】：

标签： .net documentation standards

【解决方案1】：

另请参阅 Microsoft Design Guidelines for Developing Class Libraries http://msdn.microsoft.com/en-us/library/ms229042.aspx

【讨论】：

我喜欢微软内部的编码指南。有完整版吗？还是使用相同规则的类似文档？
我认为这是完整版 - 我不希望编码指南包含更多内容 - 我们工作中的长度相似。
看起来真不错。但是技术和需求文档呢？他们有什么标准吗？
我从未见过技术或需求文档的任何标准 - 项目所需的这些标准差异很大 - 医疗和安全关键项目的需求可能需要记录到不同的级别对于那些简单的商业应用程序。
404。不幸的是，林克死了。有人带来新的链接，请...

【解决方案2】：

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

【讨论】：

【解决方案3】：

我也遇到过同样的问题，于是求助于 IEEE 寻找一些标准。我发现了以下内容，我尚未阅读，但似乎相关：

一般文档标准

除此之外，www.codingthearchitecture.com 也有很好的概述

编码风格标准

除了上面提到的非常好的“Microsoft Design Guidelines for Developing Class Libraries”之外，Linux Kernel Coding Style Guidelines 中还有一些非常好的论据，即使给出的示例是用 C 语言编写的。

【讨论】：