Je travaille dans une entreprise de systèmes de contrôle, où le travail principal est SCADA et PLC , avec d'autres trucs de systèmes de contrôle.
Le développement de logiciels n'est pas vraiment quelque chose que l'entreprise fait, à part quelques petits morceaux ici et là, jusqu'à ce qu'il ait été décidé de créer un système interne de gestion de projet et d'évaluation.
Ce projet a été entrepris par des personnes qui sont venues ici en tant que personnes logicielles à l'origine et nous sommes pour la plupart juniors.
Le projet a commencé petit, nous n'avons donc documenté que des éléments comme la conception, les bases de données, etc., mais nous ne nous sommes jamais vraiment mis d'accord sur un format / des conventions de codage.
Nous avons commencé à utiliser StyleCop pour nous assurer que nous avions un code bien documenté, mais je pense que nous avons besoin d'un document officiel pour les conventions / pratiques de codage afin que nous puissions continuer un bon standard et s'il y a plus de travail de développement majeur à l'avenir, quiconque y travaillera a une bonne plaque de base.
C'est là que réside le problème, je ne sais pas comment rédiger un document pour les conventions et normes de codage, tout ce que je peux penser, ce sont des exemples de bonnes vs mauvaises pratiques (par exemple le cas du chameau lors du nommage des variables, en évitant la notation hongroise, etc.) nous sommes tous des programmeurs suffisamment compétents (apparemment) mais nous n'avons tout simplement pas de charte pour ce genre de choses.
Pour mettre un point là-dessus, ma question est la suivante: quels sont les principaux aspects et le contenu d'un bon document sur les normes de codage?