Вот и проблема, мне нужно найти/подумать о стандартах документации для нашей команды. У нас есть несколько потребностей, мы нужны стандарты документации для Требования к документации, Техническая документация - проектов и Code Style Документация - для разработчиков, которые охватывали бы как разработчики должны назвать, и организовать код проекта (должен ли он использовать регионы? Как следует искать имена и т. д.), я знаю, что он может варьироваться от проекта к проекту, но, возможно, для этого существуют какие-то стандарты. В настоящее время каждый разработчик пишет это, как он воображает, и это не так хорошо, потому что оно противоречиво и с разными стилями и т. Д.Передовая практика: стандарты документации
Мне любопытно, как вы/ваша компания это делаете. И, может быть, для этого существуют какие-то стандарты.
Как это должно выглядеть? Какой контент он должен включать? и т. д.
BTW мы используем .NET Technologies.
Мне понравилось внутреннее руководство по кодированию Microsoft. Есть ли полная версия? Или аналогичный документ по тем же правилам? –
Я думаю, что это полная версия - я бы не ожидал, что руководство по кодированию будет содержать гораздо больше - наша работа на аналогичной длине. –
Выглядит очень хорошо. Но как насчет документации по техническим требованиям и требованиям? любые стандарты для них? –