====== Sistemas de Documentación ====== En esta sección pretendemos registrar referencias sobre diferentes sistemas de documentación que se estén empleando. Lejos de pretender ser exahustivos ===== Cómo organizar la documentación ===== Referencia: * [[https://www.divio.com/blog/documentation/|What nobody tells you about documentation]] {{ :como_organizar_documentacion.png?600 |}} ==== Tutoriales ==== * orientado al aprendizaje * suele tener el formato de una lección * ayuda a arrancar o empezar a usar una herramienta o técnica ==== Guías o Instructivos (How-To) ==== * orientado a objetivos específicos * muestra cómo resolver algún problema concreto * organizado como una serie de pasos * análogo a una receta de cocina ==== Manual de Referencia ==== * orientado a la información * es concreto y específico * no explica sino que describe * análogo a una enciclopedia ==== Explicación ==== * orientado al entendimiento o comprensión de un tema * provee el contexto teórico * expone razones ====== Herramientas para documentación ====== ===== Wikis ===== ==== Dokuwiki ==== Referencia: [[http://dokuwiki.org]] ==== Markdown ==== Lenguaje para wikis. Referencia: * [[https://commonmark.org/help/]] * [[https://en.wikipedia.org/wiki/Markdown|Markdown en Wikipedia]] * [[https://www.markdownguide.org/|Markdown guide]] ===== Pandoc ===== Herramienta para convertir entre diferentes formatos (HTML, PDF, Latex, etc.) Referencias: * [[https://pandoc.org/]] * [[https://en.wikipedia.org/wiki/Pandoc|Pandoc en Wikipedia]] ===== LaTeX ===== ==== Madoko ==== Herramienta para facilitar el uso de LaTeX a parti de Markdown y pandoc Referencia: [[https://www.madoko.net/]] ==== Mathpix ==== OCR para convertir imágenes de ecuaciones en LaTeX Referencia: [[https://mathpix.com/]]