Cómo escribir la documentación del proyecto

Question

Acabo de terminar un proyecto relativamente pequeño (~ 3000 líneas de código en varios módulos) y me pidieron que produjera un documento para el proyecto. No tengo ni idea de cómo hacerlo ya que antes he escrito código para otros programadores. ¿Describo cada módulo, hago diagramas UML para cada objeto, simplemente amplío mis comentarios? ¿Hay una plantilla que pueda usar para esto? Si alguien ha tenido que hacer documentación estándar, apreciaría su ayuda/sugerencias.

Answer 1

No hay mucho en el camino de la documentación "estándar"; Los documentos de la API de "Javadoc" son lo más parecido posible. Obtenga requisitos más sólidos. ¿Qué tipo de documentos necesita tu cliente? Los diagramas UML para todas sus clases son un ejercicio prolijo, y algunas veces útiles, pero su tiempo puede ser mejor gastado en proyectos futuros.

Answer 2

Como mínimo debe documentar

• cómo construir el software
• cómo instalarlo
• un "manifiesto" de los archivos y las herramientas necesarias
• notas de la versión: lo que ha cambiado desde la versión anterior publicada
• información de licencia y derechos de autor

Luego, dependiendo de cómo se utiliza el software, es posible que desee

• Manual del usuario
• documentación de la API

Answer 3

Usted podría hacer mucho peor que la revisión de las Descripciones de artículo DOD-STD-2178A de Datos para el Documento de diseño de software y el Documento de descripción de la versión.

El SDD describe el diseño del software. El VDD describe el paquete, incluido cómo instalarlo (descomprimirlo, compilarlo, cargarlo, configurarlo).