Forma correcta de documentar o diagramar modelos de eventos personalizados en DOM

Question

Imagine que tiene un conjunto de componentes y subcomponentes en su aplicación web. Desea realizar un seguimiento de cómo se comportan todos los eventos personalizados que agregó. ¿Existen formas establecidas de diagramar o documentar estos comportamientos?

Aquí hay algunas cosas la documentación debe mostrar:

1. La anidación real de los elementos DOM pertinentes de los diversos componentes.
2. Los nombres de los eventos y de dónde son despedidos.
3. Cualquier carga útil que se adjunte a los eventos personalizados (por ejemplo, el contenido de memo en un evento personalizado Prototipo)
4. Los lugares donde se observan los eventos.
5. Indicaciones de qué eventos se disparan en respuesta a otros eventos.
6. Donde se permite que los eventos burbujeen y dónde se detienen.

Answer 1

Nunca escuché acerca de un estándar de documentación establecido para los frontales de las aplicaciones web.

Dicho esto, como ha identificado los diferentes aspectos de la aplicación que desea rastrear, puede guardar esta información en un bloque de documentos para cada controlador de eventos y usar el jsdoc toolkit para generar algunos documentos en línea.

En mi humilde opinión, creo que ya que sabe qué es lo que desea documentar, debe tener la libertad de crear documentación en cualquier formato que tenga más sentido para usted, incluso si es completamente exclusivo para su aplicación u organización. 8 horas en stackoverflow sin respuestas deben significar que no hay una respuesta estándar;)

Answer 2

Honestamente solía AMAR al modelador visual, y cuando MS lo dejó para Visio, me decepcionó un poco.

Dicho esto, Visio sigue siendo una gran herramienta, y puede usarlo para crear modelos de objetos de objetos y definir eventos, propiedades, métodos, etc. Tiene algunas funciones incorporadas para diseños UML y todo.

Pero tengo que decir que al final, generalmente termino con el bloc de notas o MS Word. Dependiendo de lo detallado que desee con su documentación, escribir notas o una descripción para un componente nunca encaja muy bien en ningún tipo de herramienta DOM, pero puede negrita, tabular, listar y poner en cursiva como un loco dentro de un documento Word .

Suena triste, ¡pero es verdad!