Cómo preparar la documentación técnica de una aplicación web

Mi enfoque sería similar al de Christophe Razafimahatratra.

Además, yo haría:

  • Prepare una serie de breves documentos de diseño que se centren en las opciones de diseño clave, las alternativas que consideró y por qué eligió el diseño que implementó. Esto salvará a las personas en el futuro (incluido usted mismo) de adivinar sus opciones de diseño y facilitará la reconsideración cuando los requisitos o la tecnología hayan cambiado.
  • Prepare diagramas de modelo de datos de alto nivel que describan las estructuras de almacenamiento persistentes y las estructuras internas importantes. Una imagen vale mas que mil palabras.
  • Documente cualquier esquema de codificación / encriptación complejo o especializado, algoritmos, gramáticas de lenguaje o protocolos. (Si su aplicación admite algo como CSV, asegúrese de documentar la gramática que realmente admite o haga referencia a un estándar que admita. Para cosas como JSON o XML, no es necesario documentar la gramática general, pero podría ser útil decir algo sobre el estructura y semántica de su uso específico de la misma en la aplicación.)
  • Documente lo que un desarrollador necesitaría saber sobre el entorno técnico para la aplicación, como qué software se necesita para construirlo, dónde obtener ese software, si se necesitan licencias (y cómo / dónde obtenerlas) y cómo construir eso.

Puede seguir la documentación de la aplicación Spring PetClinic .

Enlace de aplicación en vivo: http://petclinic.cloudapp.net

Enlace de documentación – La aplicación Spring PetClinic

Comente todas las clases, métodos y propiedades de su código. Luego use un generador de documentación como doxygen (eche un vistazo a Doxygen: Página principal)

Si usa MySQL, puede comentar todas las tablas y columnas de su base de datos y luego generar la documentación de su base de datos. (Puedes hacerlo desde phpmyadmin)