Please enable JavaScript.
Coggle requires JavaScript to display documents.
PILDORA 4 - Coggle Diagram
PILDORA 4
Generación de documentación
HERRAMIENTAS DE GENERACIÓN DE DOCUMENTACIÓN php
phpDocumentor
Funciona de manera similar a Javadoc, generando documentación a partir de comentarios y anotaciones en el código fuente.
Permite generar documentación en formato HTML o PDF mediante anotaciones estándar de PHPDoc para extraer información del código.
Scribe
Es una herramienta para generar documentación de API en Laravel. Scribe permite crear documentación basada en las rutas y controladores de Laravel, y puede generar ejemplos automáticos de solicitudes y respuestas.
Formatos de documentación de código
Es crucial que los desarrolladores y equipos de software comprendan cuál es el formato más adecuado para cada caso.
Markdown
Usado ampliamente en entornos de desarrollo colaborativo, especialmente en plataformas como GitHub.
Plain Text
Simple y directo, ideal para notas rápidas o archivos README básicos.
PDF
Popular para manuales y guías de usuario que necesitan portabilidad.
XML/JSON
Formatos estructurados usados para documentación de configuración de software y APIs.
HTML
Utilizado generalmente para documentaciones de API y sitios web.
LATEX
Formato especializado para crear documentación técnica de alta calidad (PDFs científicos y académicos).
Herramientas de generación de documentación
La documentación técnica ayuda a los desarrolladores y usuarios a comprender el funcionamiento del sistema, facilita el mantenimiento y asegura la continuidad del proyecto a largo plazo.
Herramientas de generación de documentación js
JsDoc:
Es una herramienta para generar documentacion en proyectos de js, similar al PHPDoc o el JavaDoc, utiliza comentarios en el codigo para generar documentacion sobre funciones,objetos,clases y metodos.
VuePress
Es un generador de sitios estáticos optimizados para crear documentación, aunque esta diseñado para generar sitios web, sirve también para documentar proyectos.
Swagger
Es una herramienta para documentar APIs en Laravel.Puede generar automáticamente documentación interactiva en las APIs
Control de Versiones
Practica que permite controlar, gestionar y organizar mejor los proyectos de software
Herramientas
GIT
Flujo de trabajo
Pasos a seguir para tener organizado los proyectos
Clonar repositorio
Crear Rama
Hacer cambios
Enviar Cambios
Esperar confirmacion
WIKI
Guia de trabajo para los proyectos