Trabajo en una compañía de sistemas de control, donde el trabajo principal es SCADA y PLC , junto con otras cosas de los sistemas de control.
El desarrollo de software no es realmente algo que la empresa haga, aparte de las pequeñas partes aquí y allá, hasta que se tomó la decisión de crear un sistema interno de gestión y evaluación de proyectos.
Este proyecto ha sido desarrollado por personas que vinieron aquí como personas de software originalmente y en su mayoría somos junior.
El proyecto comenzó pequeño, así que solo documentamos cosas como diseño, cosas de base de datos, etc., pero nunca acordamos un formato de codificación / convenciones.
Comenzamos a usar StyleCop para asegurarnos de que teníamos un código bien documentado, pero creo que necesitamos un documento oficial para las convenciones / prácticas de codificación. por lo que podemos continuar con un buen estándar y si hay más trabajos de desarrollo importantes en el futuro, quienquiera que trabaje en él tiene una buena placa base.
Ahí radica el problema, no tengo idea de cómo redactar un documento para codificar convenciones y estándares, todo lo que puedo pensar es en ejemplos de buenas y malas prácticas (por ejemplo, caso de camellos al nombrar variables, evitar la notación húngara, etc.) todos somos programadores lo suficientemente competentes (aparentemente) pero simplemente no tenemos un estatuto para este tipo de cosas.
Para explicarlo, mi pregunta es: ¿Cuáles son los aspectos y contenidos clave de un buen documento de estándares de codificación?