La documentación es imprescindible a la hora de realizar un desarrollo software. Muchos de nosotros seguramente tocamos varias tecnologías como Java, C#, HTML+CSS+JS para las Webs, Objetive-C para el mundo Apple, algunos frameworks de desarrollo etc. Llegados a este punto es muy normal confundir algunas funciones entre lenguajes, lo que nos obliga a estar consultando de manera muy frecuente internet, con la consiguiente pérdida de tiempo que eso supone. Además en algunos casos puede que no tengamos acceso a una red y en ese caso podemos tener varios problemas y tener que retrasar el desarrollo.
Tabla de contenidos
La importancia de la documentacion
La documentación hoy en día, es una de las cosas más importantes de cualquier producto o tecnología software, en algunos casos es tan importante, que grandes desarrollos que carecen de ella o cuya documentacion es muy pobre, no han tenido aceptación por parte de los desarrolladores. Además los distintos lenguajes con su documentacion y los estándares nos permiten realizar programas que sean portables, es decir, que puedan ejecutarse en distintas máquinas, al aceptar todas el mismo estándar o revisión de ese lenguaje (en algunos casos nativo y en otros casos previa compilación).
Cómo obtener la documentacion necesaria
Documentacion online
En la mayoría de los casos, cuando necesitamos buscar algo sobre cualquier de las tecnologías que utilicemos solemos usar Google o cualquier otro buscador, los más puristas entrarán en StackOverflow para ir más al grano. Pero en la mayoría de los casos tenemos que realizar una navegación que nos llevará por múltiples páginas hasta dar con la información que necesitamos.
Documentacion offline
Obtener la documentacion offline de la tecnología que usemos puede ser una salvación en muchos casos, como por ejemplo cuando no estamos en un lugar con acceso a la red o cuando esta tiene una velocidad tan lenta, que usarla nos da la sensación de estar perdiendo tiempo de una manera clara. Para solucionar todos estos problemas tenemos a Zeal, esta aplicación nos permite descargar toda la documentación del lenguaje de programación, tecnología o framework que utilicemos y luego solo necesitamos usar su buscador para encontrar aquella función que se nos resistía o ese método que no tenemos claro, los argumentos que recive.
Zeal es la versión para Windows y LInux, en Mac lo podemos buscar por Dash, pero el funcionamiento es muy similar. Lo mejor de todo, es que lo podemos meter en un pendrive un llevarnos toda la información siempre con nosotros, ya que uno nunca sabe cuando va a tener que programar algo.
Os dejo unas capturas de su uso y lo sencillo que es utilizarlo.
Interfaz de usuario de Zeal con la documentacion que yo necesito
Buscando conceptos nuevos de CSS en Zeal
Buscando la función printf de cada lenguaje en Zeal
Espero que os guste la entrada y como siempre, esperamos vuestros comentarios.
3 comentarios en “La documentacion para programar”
Dani García
¡Qué pasada! Seguro que es muy útil, voy a probarlo.
Dani García
¿Se pueden añadir documentaciones no oficiales de los distintos módulos instalados?
SomosBinarios
En su web oficial dicen como se puede añadir documentación, pero debe usar su formato:
https://kapeli.com/docsets
Por ejemplo para python esta lo siguiente https://pypi.python.org/pypi/doc2dash