Voici le problème, je dois trouver/penser aux normes de documentation pour notre équipe. Nous avons plusieurs besoins, nous avons besoin de normes de documentation pour Exigences Documentation, Documentation technique - pour les projets et Style Code Documentation - pour les développeurs qui expliquent comment les développeurs devraient nommer et organiser la Le code du projet (devrait-il utiliser les régions? Comment devrait apparaître le nom?), je sais que cela peut varier d'un projet à l'autre, mais peut-être y a-t-il des normes pour cela. Actuellement, chaque développeur l'écrit comme il l'imagine, et ce n'est pas très bon, parce qu'il est incohérent, et avec des styles différents, etc.Bonne pratique: Normes de documentation
Je suis curieux de savoir comment vous/votre entreprise faites cela. Et peut-être y a-t-il des normes pour cela.
À quoi cela devrait-il ressembler? Quel contenu devrait-il inclure?
BTW nous utilisons des technologies .NET.
J'ai aimé la directive de codage Microsoft interne. Y a-t-il une version complète? Ou un document similaire en utilisant les mêmes règles? –
Je pense que c'est la version complète - je ne m'attendrais pas à ce qu'une directive de codage en contienne beaucoup plus - notre version au travail est de la même longueur. –
Ça a l'air vraiment sympa. Mais qu'en est-il des documentations techniques et des exigences? des normes pour eux? –