Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Best Practice: Documentation Standards [closed]

Here is the issue, I need to find/think of documentation standards for our team. We have several needs, we need documentation standards for Requirements Documentation, Technical Documentation - for projects and Code Style Documentation - for developers which would cover how developers should name, and organize the project's code (should he use regions? How should naming look? etc.), I know it can vary from project to project, but maybe there are some kind of standards for that. Currently each developer writes it as he imagines, and that is not so good, because it is inconsistent, and with different styles etc.

I'm curious how you/your company does that. And maybe there is some kind of standards for that.

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

BTW we use .NET Technologies.

like image 231
Lukas Šalkauskas Avatar asked Dec 08 '22 05:12

Lukas Šalkauskas


2 Answers

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

like image 82
Matt Breckon Avatar answered Jan 05 '23 14:01

Matt Breckon


Here is a very good book: Microsoft Manual of Style for Technical Publications.

like image 37
Alexandra Rusina Avatar answered Jan 05 '23 14:01

Alexandra Rusina