Hay una serie de fuentes que todo programador consulta cuando está programando. Habitualmente la documentación que más utilizamos es la oficial del desarrollador de nuestro lenguaje favorito, sea NodeJS, Python, la plataforma .NET o incluso HTML+CSS+JavaScript. En este último caso, al igual que otros, lo más práctico es consultar alguna referencia de calidad contrastada (como por ejemplo la Mozilla Developer Network), porque leerse el estándar no es precisamente lo más práctico ni operativo del mundo.
Todas estas fuentes suelen estar muy bien pero tienen un par de problemas principalmente:
- La búsqueda no es eficiente: claro que podemos buscar, pero la búsqueda es relativamente lenta porque se hace on-line, tardando varios segundos o minutos en encontrar lo que buscamos, puesto que primero tiene que devolver los resultados de búsqueda y luego debemos ir entrando en ellos (y cargando nuevas páginas una a una) hasta encontrar lo que necesitamos.
- Si no tenemos conexión, no hay acceso a la documentación: vale que hoy en día no es habitual estar desconectados de la Red, pero ¿qué pasa si vamos de viaje en transporte público (tren, avión...) y queremos programar? ¿Y en el pueblecito al que nos vamos de vacaciones donde no llega la banda ancha ni el 4G?
Para tratar de solucionar estos problemas y facilitar un acceso rápido, eficiente y sin conexión a las principales documentaciones de programación surge la herramienta Zeal:
Creada por el programador ucraniano afincado en Nueva York, Oleg Shparber (conocido en Internet como Trollixx), esta herramienta es capaz de descargar y almacenar para uso sin conexión la documentación completa de 198 lenguajes y plataformas de programación.
La lista es enorme y casi seguro que encuentras el lenguaje que usas para trabajar:
Desde la plataforma .NET, Java o Apache Cordova, hasta lenguajes como Swift, Go, Ruby, Python, pasando por todo tipo de bibliotecas importantes de JavaScript (AngularJS, jQuery,RequireJS, Lo-dash...).
Una vez que lo instalas está completamente vacío. Para añadir conjuntos de documentación (docsets) debes ir al menú de opciones de Zeal, pestaña Docsets, y seleccionar en la lista los que necesites tener disponibles. Al hacerlo se pondrán a descargar en segundo plano:
OJO: Mucho cuidado con lo que marcas: las documentaciones off-line ocupan mucho espacio y pueden llegar a suponer muchos GB de espacio consumido en tu disco duro.
Para que te hagas una idea, por ejemplo la documentación de JavaScript son más de 600 MB y la de HTML5 casi medio GB. Es decir, solo con estos dos lenguajes "de base" estarás ocupando más de 1GB de espacio en tu disco duro y tardarán unos cuantos minutos en descargar, según tu ancho de banda.
Una vez instalados los docsets es muy fácil utilizarlos. Por un lado tienes un árbol de documentación ubicado a la izquierda que te permite ir desplegando la documentación por temáticas:
Además esta documentación puede que esté unificando en un solo conjunto documentación obtenida de varios lugares, lo cual es muy cómodo y nos ofrece lo mejor en cada caso sin tener que visitar varios sitios webs.
Por otro lado podemos realizar búsquedas casi instantáneas sobre cualquier palabra clave, pudiendo abrir varias pestañas además (desde el menú "Tabs") para tener diferentes resultados y documentaciones abiertas al mismo tiempo (mira la primera figura de este documento).
En realidad toda esa documentación viene de un proyecto muy conocido para Mac llamado Dash. Zeal es algo así como una versión para Windows y Linux de Dash, plataformas en las que no está disponible el conocido navegador de documentación para el sistema de la manzana.
Además, si hay un lenguaje o plataforma que usas y no está contemplado en el proyecto siempre puedes definir un script personalizado de descarga de documentación, que te permitirá descargar la documentación para uso off-line y que incluso podrás aportar al proyecto Dash para que esté disponible tanto en Dash como en Zeal.
Una última advertencia: si decides en algún momento desinstalar Zeal de tu equipo ten en cuenta que los docsets no se desinstalan. Por ello, si quieres liberar tu disco duro del espacio utilizado (que pueden ser varios GB), deberás ir a la carpeta "Zeal" dentro de la ruta local de tu usuario para borrar su contenido a mano:
De esta forma sí que podrás liberar el disco como es debido si tienes poco espacio.
Descarga Zeal ahora