Lista de comprobación: Definir estándar de documentación técnica |  |

Checklist para definir estándar de documentación técnica

Elementos de comprobación

Se especificaron las normas que se deberán seguir para

La realización de los diagramas correspondientes utilizando el lenguaje de modelado UML (Unified Modeling Language).

Los nombres de los objetos, clases, atributos, relaciones, tipos de letra y tamaño, comentarios, etc.
La documentación de los subsistemas, asignación de nombres, comentarios, descripciones, etc., y para los subsistemas y componentes que lo integran
La documentación de los componentes, asignación de nombres, comentarios, descripciones, etc.
La documentación de las interfaces, asignación de nombres, comentarios, descripciones, etc.

Se establecieron las convenciones para

Estableció las convenciones generales que serán seguidas en la implementación, por ejemplo comentarios de las prestaciones generales de los componentes, comentarios en cada método, forma y ubicación de los comentarios, etc.
Nombres a variables, forma y ubicación de comentarios, uso, etc.
Nnombres a constantes, forma y ubicación de comentarios, uso, etc.
Indentación en general del código, para las estructuras de control de flujo, forma y ubicación de comentarios, etc.