Documentación Flashcards
¿Cuáles son los tipos de manuales?
Del usuario final, del administrador, técnico, de instalación y de mantenimiento
Manual del usuario final
Da al usuario final instrucciones claras y prácticas para el uso del sistema
Manual del administrador
Muestra como gestionar configuraciones avanzadas, permisos, mantenimiento,…
Manual técnico
Enseña cómo está montada la arquitectura del programa, el sentido del código, los payloads de las APIs,…
Manual de instalación
Comenta los requisitos de instalación y cómo hacerlo paso a paso
Manual de mantenimiento
Muestra cómo mantener el sistema actualizado, resolver errores,…
Etiqueta summary
Permite agregar una descripción en C#
Aplicación de summary en código real
/// <summary>
/// “Descripción”
/// </summary>
/// <param></param> Numero de — </param>
/// <returns> Resultado </returns>
ToolTip
Pequeña ventana emergente con texto que aparece al pasar sobre un elemento. Dan información sin sobrecargar
GhostDoc
Genera automáticamente comentarios XML basándose en nombres de métodos y su estructura, simplificando la documentación interna
HelpNDoc
Permite crear documentación en diferentes formatos, con una gestión sencilla de proyectos de documentación
F1
Generador de ayuda. Abre una ayuda contextual en la app
¿Qué evento se dispara al pulsar F1?
HelpRequested
