Frecuentemente utilizo muchos frameworks open source como parte de mi trabajo. Durante el transcurso de las actividades diarias es perfectamente normal que realice ajustes en HTML5, CSS3, trabaje con Bootstrap, Foundation, XML/JSON, modifique alguna función de jQuery y extienda algún CMS además de experimentar con cosas como Node y Angular en mi tiempo libre.
La mayoría del desarrollo web es multidisciplinario, así que requieres flexibilidad y referencias rápidas para realizar los ajustes comúnes que requiere éste tipo de trabajo.
Generalmente, los desarrolladores se refieren a la documentación sólo a través de búsquedas en Google y muy pronto llenan pestañas y pestañas de links de dudosa calidad y ejemplos que no siempre resultan útiles.
Baja calidad de referencias; baja calidad de código
Ésto casi siempre acaba con copiar y pegar código o realizar fixes temporales (kludges) que degradan la calidad del código. El ejemplo canónico en desarrollo de Frontend es "No conozco los nombres de clases o funciones, me lo aviento con un style=".
Todos hemos pasado por alguna historia de terror viendo ésta clase de código en producción.
Mi sugerencia para tener la mejor documentación disponible al alcance y evitar la degradación de la calidad de código es utilizar la documentación oficial del Framework/Software antes de realizar la típica sesión de Google.
Porqué tener documentación local
Tener una copia local de la documentación oficial tiene las siguientes ventajas:
- El acceso es más rápido
- Puedes trabajar y usarla offline
- Es más fácil de utilizar que realizar búsquedas
- La carga cognitiva es menor que tener las 30+ pestañas comúnes en el Browser.
Ahora, para simplificar el proceso se puede usar un par de programas y personalizaciones al flujo de trabajo Web.
Zeal y acceso rápido a la documentación
Zeal es un lector de documentación offline Open Source para GNU/Linux y Windows que descarga una copia oficial al equipo y ofrece funciones como buscador, pestañas, árbol de contenido y actualización automática de la documentación.
Para facilitar el uso de la documentación offline puedes integrar Zeal con tu IDE para hacer lookups más rápidos.
Spacemacs incluye una Configuration Layer en su distribución, solo tienes que agregar zeal a dotspacemacs-configuration-layers en tu archivo .spacemacs .
Zeal está basado en Dash, si eres usuario de Mac OS X (so sorry) puedes probarlo.
Extendiendo nuestra base de conocimiento
Por favor noten que sugiero la documentación offline como una base de conocimiento estable que complementa la búsqueda y uso de recursos como páginas Web, artículos, IRC y preguntarle al compañero del al lado. Obviamente hay casos y situaciones que requieren mayor especialización, sin embargo, la referencia local cubre una área amplia de las dudas normales de uso y desarrollo.
Como plus, si deseas utilizar una organización similar para la documentación pero no cuentas con un servicio o plataforma similar (por ejemplo, desarrollando en una Chromebook (so sorry)) y cuentas con acceso web, puedes checar devdocs.io o sitios similares.