No estoy seguro de si está preguntando sobre el proyecto o la documentación del usuario.
Tampoco estoy seguro de por qué dice que UML no es adecuado para aplicaciones web. UML es solo un lenguaje de modelado, que se puede utilizar para documentar actividades de modelado (análisis, diseño, …). Si se usa UML, debe incluirse, pero la documentación también debe contener el resultado de las otras actividades del proyecto.
Si desea un ejemplo de posibles actividades del proyecto, eche un vistazo a la lista SYSMOD de productos de trabajo: http://www.sysmod.de/sysmod.proc…
- ¿Cuáles son las ventajas y desventajas de usar Sinatra vs Express para un servicio web API?
- ¿Qué es una buena aplicación para administrar el calendario de contenido de un sitio web?
- ¿Cuál es el rol del framework web backend con AngularJS en la interfaz?
- ¿Cómo puede un sitio de citas generar zumbido viralmente?
- ¿Cuáles son algunos de los mejores hacks que has visto?
En otras palabras:
1.- Piensa magra. ¿Qué actividades NECESITAMOS REALMENTE para el proyecto?
2.- Elija cómo se documentan los resultados de estas actividades (por ejemplo, diagramas UML, tarjetas de papel para historias de usuarios, etc.).
3.- Incluir los resultados de estas actividades en la documentación del proyecto.
4. Evite documentar al final del proyecto; si lo hace, probablemente no necesite ESA documentación.
Para la documentación de usuario de las aplicaciones web, la forma más común es usar los casos de uso / historias de usuario) como base, describiendo la GUI de manera similar a una lista de procedimientos:
– Escribir un correo
– Crear un contacto
– y así
