Agregue y vea documentación en tiempo real en páginas. Los nombres alternativos para este módulo podrían ser «Documentación Contextual» o «Documentación en tiempo real», pero inline tiene un buen timbre y coincide con la forma en que se coloca la documentación en el código.
Este módulo creará un tipo de contenido «Documentación en línea» y agregará un botón azul redondo en la esquina inferior derecha de cada página. Este botón alterna un panel que contiene una lista de los nodos de documentación en línea.
La documentación es la clave para facilitar el mantenimiento o la transferencia de proyectos. Sin embargo, a nadie le gusta escribir documentación y a nadie le gusta leer documentación.
La documentación en línea intenta facilitar la carga de escritura de documentación simplemente permitiendo al usuario agregar pequeños fragmentos de documentación directamente a la página web donde el lector lo necesita. Esto disminuye la necesidad de páginas Wiki extensas y documentos de Word.
Vaya a la página en cuestión, haga clic en el botón «Agregar documentación» y comience a escribir algunos documentos. Se recomienda mantener estos documentos cortos y simples, puede agregar tantos como desee a una página e incluso puede adjuntarlos a elementos DOM.