Objetivos
- Aprender a escribir documentación técnica.
Versión imprimible multipagina. Haga click aquí para imprimir.
Escribir documentación técnica
Escribir documentación técnica con markdown
1 - Markdown
Objetivo
- Qué es Markdown?
- Por qué usar Markdown
Documentación
Qué es Markdown?
- https://www.writethedocs.org/guide/writing/markdown/
- Guía básica de Markdown: https://www.markdownguide.org/basic-syntax/
Guías de estilo de documentación
- https://developers.google.com/style
- https://ivansantosgonzalez.dev/the-desired-documentation/
- https://jesuslc.com/2016/07/12/como-escribir-un-readme-que-mole/
Más recursos sobre markdown y documentación
Herramientas
- Visual Studio Code: https://code.visualstudio.com/
- Editor online de README: https://readme.so/editor
2 - Ejercicio Markdown
- Primer ejercicio con Markdown
- https://www.lemoncode.tv/curso/vscode-markdown/leccion/basico
Objetivo
Sigue las instrucciones de este vídeo tutorial https://www.lemoncode.tv/curso/vscode-markdown/leccion/basico
Previo
Tienes que tener instalado Visual Studio Code (https://code.visualstudio.com/)
Ampliación
Puedes ampliar exportando a pdf y usando el corrector ortográfico