Geek Answers Handbook

Best practice: documentation standards

Here is the question I need to find / think about documentation standards for our team. We have several requirements, we need documentation standards for Documentation Documents , Technical Documentation for projects and Code Style Documentation for developers who will cover what developers should call and organize the project code (if it will use regions? How to look for names, etc.), I know that it can vary from project to project, but maybe there are some standards for this. Currently, each developer writes this as he imagines, and this is not so good, because it is contradictory with different styles, etc.

I'm curious how you / your company do it. And perhaps there are some standards for this.

What should it look like? What content should it include? etc..

By the way, we use .NET Technologies.

+4
source share
3 answers

Brad Abrams posted an example of his internal Microsoft coding guide on his blog several years ago: http://blogs.msdn.com/brada/articles/361363.aspx

See also Microsoft Development Guide for Developing Class Libraries http://msdn.microsoft.com/en-us/library/ms229042.aspx

+9
source

Here is a very good book: Microsoft Style Publishing Style Guide .

+3
source

I had the same issue, and I turned to IEEE to find some standards. I found the following, which I have not read yet, but that seems to matter:

General documentation standards

Other than that, there is also an excellent overview at www.codingthearchitecture.com

Coding Style Standards

Besides the very thin “Microsoft Design Guide for Developing Class Libraries” mentioned above, there are some very good arguments that can be found in the Linux kernel coding style rules , although the examples are given in C.

+2
source

More articles:


All Articles