Please enable JavaScript.
Coggle requires JavaScript to display documents.
DOCUMENTACIÓN Y CONTROL DE VERSIONES - Coggle Diagram
DOCUMENTACIÓN Y CONTROL DE VERSIONES
¿QUE HACE?
Permite entender como funciona el sistema
Facilita el mantenimiento y continuidad
Analizan el código y genera comentarios con información sobre las funciones, clases, variables...
Ahorran tiempo, es consistente y fácil de mantener
FORMATOS
HTML | API/Web
PDF | Manual/Guía de usuario
MARKDOWN | Github, entornos dev en equipo
Plain Text | Notas y README
XML/JSON | API, cofig. software
Latex | Doc. técnica de calidad
HERRAMIENTAS DOCUMENTACIÓN
JavaScript
VuePress | Vue.js
Swagger | APIs en Laravel/Node.js
JSDoc | JavaScript
PHP
phpDocumentor | PHP
Scribe | API en Laravel
CONTROL DE VERSIONES Y FLUJO DE TRABAJO
Herramienta para equipos de desarrollo
Permite gestionar cambios en el código de forma clara y segura
Registra cambios en archivos/carpetas del código del programa, pudiendo reversitr, comparar o colaborar con otras personas
WIKI
Herramienta de software colaborativa
Permite crear, editar, organizar y compartir contenido sobre el programa
Formada por
Página de inicio
Documentación técnica
Componentes
Clases y funciones
Guía de instalación
Guía de estilo de código
Preguntas frecuentes