Cuando creamos la documentación para un proyecto muchas veces es una dificil decision que vamos a agregar, o no, dentro de esta. Se puede ir desde detalles muy especificos lo que puede llegar a abrumar al que necesite consultar la documentación si es mas de lo que era necesario o bien crear una documnetación que… Seguir leyendo Empatia como el motor de la documentación
Categoría: Documentación
Utilizando enlaces para potenciar la documentación con MD
Generalmente cuando pensamos en enlaces, o vínculos, no podemos evitar pensar en redireccionamiento a sitios externos al nuestro, que contengan información útil para el lector del texto o bien que expandan el contenido de este. En Mark Dawn es posible utilizar los enlaces de esta forma pero también es posible crear enlaces que dirijan a sitios específicos dentro de nuestro propio documento, como puede ser un título o una línea en específico, o bien a documentos dentro de nuestro proyecto. Esto es de gran utilidad para hacer documentación mas explicita y que pueda, de forma sencilla, ser seguida por los usuarios que tengan acceso a ella.
Markdown, un lenguaje con superpoderes
El manejo de la sintaxis básica de Markdown nos puede permitir crear documentación mas elaborada y especifica.