Compodoc: Crea documentación en proyectos Angular/Ionic/TS

Description

IMPORTANTE: Este curso está pensado para proyectos desarrollados en Angular, Ionic y Typescript. NO SIRVE para documentar proyectos de otros frameowrks como pueden ser Django, Laravel, Symfony,...

La importancia de documentar nuestros proyectos es grande y más si estamos en un equipo de desarrolladores en el que cada miembr@ del equipo desarrolla diferentes funcionalidades por lo que se antoja importante tener todo bien documentado y ordenado.

Con esto conseguimos que el desarrollo sea lo más eficiente posible y en el caso de que  entren más desarrolladores puedan coger el hilo del proyecto de la manera más rápida y eficiente sin mucho esfuerzo.

En este curso aprenderemos el uso de la herramienta Compodoc que nos permite crear una documentación elegante y de calidad básica en pocos pasos con facilidad y que será muy fácil de mantener siguiendo unas breves pautas.

Aparte de aprender a crear la documentación básica, aprenderemos a configurar para que mediante la configuración de las diferentes opciones podamos mostrar la documentación con un template u otro, mostrando documentación de apoyo y etc.

Lo que aprenderemos teniendo como base un proyecto de Angular que contiene pipes, componentes, directivas, servicios, constantes, interfaces,... será lo siguiente:

1. Crear nuestra primera versión de la documentación con las opciones por defecto.

2. Cambiar de template y crear diferentes variantes.

3. Como crear documentación adicional con las instrucciones / información del proyecto

4. Personalizar nuestro template modificando secciones como los títulos, añadiendo logotipos propios,...

5. Aplicar tips y trucos interesantes para crear una documentación más personalizada.

6. Sección extra con un proyecto de Ionic desde 0 con una práctica tipo reto en el que vamos a repasar todo lo aprendido en el curso.

7. Capaces de publicar nuestra documentación en Github mediante Github Pages.

Lo explicado en este curso se realizará principalmente con el proyecto de Angular únicamente ya que el proceso de configuración, generación de documentación y demás aspectos son iguales tanto en Angular e Ionic, por lo que no creo que tenga mucho sentido hacerlo de nuevo paso por paso en Ionic pero si alguien tiene alguna duda concreta que pregunte sin miedo!!

Para ello, he añadido la sección extra, para trabajar con este framework y practicar todo lo aprendido anteriormente.

Espero que el curso les sea ameno, útil y cuando lo terminéis, publiquéis una documentación elegante, limpia y de calidad en la red con la información de vuestros proyectos como aplicaciones Android / iOS en Ionic, proyectos de Angular, librerías,...

Course Info