Eu trabalho em uma empresa de sistemas de controle, onde o trabalho principal é SCADA e PLC , juntamente com outras coisas de sistemas de controle.
O desenvolvimento de software não é realmente algo que a empresa faz, além de pequenos detalhes aqui e ali, até que houve uma decisão de criar um sistema interno de gerenciamento e avaliação de projetos.
Este projeto foi assumido por pessoas que vieram aqui como pessoas de software originalmente e somos principalmente juniores.
O projeto começou pequeno, então apenas documentamos coisas como design, material de banco de dados etc., mas nunca concordamos com um formato / convenções de codificação.
Começamos a usar o StyleCop para garantir que tivéssemos um código bem documentado, mas acho que precisamos de um documento oficial para convenções / práticas de codificação, para que possamos continuar com um bom padrão e se houver mais trabalho de desenvolvimento importante no futuro, quem trabalha nele tem uma boa placa de base.
Aí reside o problema, não tenho idéia de como redigir um documento para convenções e padrões de codificação, tudo o que consigo pensar são exemplos de boas e más práticas (por exemplo, caso de camelo ao nomear variáveis, evitando a notação húngara, etc.) programadores competentes o suficiente (aparentemente), mas simplesmente não temos um termo para esse tipo de coisa.
Para colocar um ponto, minha pergunta é: Quais são os principais aspectos e conteúdo de um bom documento sobre padrões de codificação?