最佳实践:文档标准

Luk*_*kas 4 .net documentation standards

这是问题,我需要找到/想到我们团队的文档标准.我们有几个需要,我们需要对文档标准需求文档,技术文档 - 用于项目代码风格的文档 - 开发商这将包括开发者应该如何命名,并组织项目的代码(他要利用地区应该如何命名期待等? .),我知道它可能因项目而异,但也许有一些标准.目前,每个开发人员都按照他的想象来编写它,但这并不是很好,因为它不一致,并且具有不同的样式等.

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

应该怎么样?它应包含哪些内容?等等..

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

Mat*_*kon 10

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

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