DevDocs: plataforma de documentación para buscar varios documentos técnicos en un solo lugar

 (devdocs.io)
3 puntos por GN⁺ 2024-01-14 | 1 comentarios | Compartir por WhatsApp
  • Reúne en un solo lugar la documentación de API que los desarrolladores consultan con frecuencia para poder buscarla rápido, reduciendo el costo de cambiar entre documentos según lenguaje o framework
  • De forma predeterminada se muestran CSS, HTML, HTTP, JavaScript y Web APIs, y en Preferences se pueden activar más documentos y ajustar la pantalla según sea necesario
  • Permite acceder más rápido a lo que buscas con búsqueda difusa para encontrar background-clip usando bgcp, además de definir el alcance de búsqueda por documento
  • Ofrece atajos de teclado para usarlo sin mouse, búsqueda desde la barra de direcciones del navegador, uso en móvil e instalación como aplicación web
  • Se puede consultar la documentación incluso sin conexión, y al ser un proyecto gratuito y de código abierto se puede usar sin problema en distintos entornos de desarrollo

Buscar varios documentos de API en un solo lugar

  • DevDocs combina varios documentos de API en una sola interfaz de búsqueda rápida y ordenada
  • En la pantalla principal se muestran los documentos de CSS, HTML, HTTP, JavaScript y Web APIs
  • En Preferences se pueden activar más documentos y hacer personalización de la UI

Cómo funciona la búsqueda y la navegación

  • La búsqueda admite búsqueda difusa
    • Por ejemplo, si escribes bgcp, puedes encontrar background-clip
  • Si quieres buscar solo dentro de un documento específico, escribe el nombre del documento o su abreviatura y luego usa Tab para limitar el alcance de la búsqueda
  • También se puede usar la búsqueda desde la barra de direcciones del navegador, y la forma de configurarla se puede consultar en la guía

Uso centrado en el teclado

  • Se puede navegar y buscar sin usar el mouse
  • Puedes ver la lista de atajos de teclado o presionar ? para revisar los atajos disponibles

Soporte sin conexión e instalación

  • DevDocs funciona también sin conexión
  • Se puede usar en móvil y se puede instalar como aplicación web

Proyecto gratuito y de código abierto

Lecturas relacionadas

1 comentarios

 
GN⁺ 2024-01-14
Opiniones de Hacker News

  • Soy uno de los pocos mantenedores de DevDocs
    Actualizar la documentación para nuevas versiones es fácil, salvo cuando cambia por completo el sistema de documentación o el diseño. Aunque parece que algunos proyectos hacen rediseños de este tipo con bastante frecuencia, como el rediseño de react.dev
    Algunos generadores de documentación crean nombres de clase aleatorios como .gtWOdv, .ezMiXD, .gOhcvK, que Gatsby genera en docs.npmjs.com, lo que hace que quitar contenido innecesario como la navegación de la página sea una tarea engorrosa e inestable
    Cada mes generamos automáticamente una lista de documentación desactualizada, y la lista más reciente está aquí: https://github.com/freeCodeCamp/devdocs/issues/2105
    La ayuda siempre es bienvenida

    • simon04, el trabajo que hicieron los mantenedores hace mucho tiempo marcó una gran diferencia en mi carrera y, más adelante, también en mi vida
      Poder leer documentación offline durante mis traslados mientras trabajaba en un proyecto de software urgente fue realmente importante
      Quizás no hayan ganado ni un centavo ayudando a devdocs, pero quiero que sepan que están ayudando a personas reales
    • Esta app, en lo personal, me resulta bastante frustrante. Es una de las mejores fuentes de documentación, pero se volvió casi inutilizable porque no logra conservar la lista de documentos que seleccioné
      Casi cada vez que la visito tengo que volver a elegir desde cero el stack que uso. Es excelente, pero no tanto como para repetir eso una y otra vez
      No tengo problemas de desaparición de cookies o almacenamiento local en otros sitios, y uso Chrome actualizado en Linux. ¿Alguna idea de cuál podría ser la causa?
    • ¿Podrías evaluar los generadores de documentación según qué tan fáciles de consumir son?
      Me gustaría saber cómo se comparan Sphinx, Docsy, MkDocs, Docbook y otros en cuanto a lo fácil que es extraerlos semánticamente
    • En una entrevista técnica una vez me preguntaron cómo haría XYZ con cierto framework
      Respondí que no lo sabía con exactitud, pero que buscaría la interfaz de la API en devdocs.io para entenderlo mejor
      El entrevistador no entendió a qué me refería, así que lo abrió directamente en su laptop y quedó bastante sorprendido
      Por supuesto, no conseguí ese trabajo, pero fue bastante genial difundir conocimiento al otro lado de la mesa de entrevistas
    • Que este sitio siga vivo es gracias a contribuciones como estas y, como resultado, me dieron ganas de dar una charla sobre mis actualizaciones favoritas desde Python 3.8
      Podría haber encontrado los datos por mi cuenta, pero hace que comparar por versiones sea muy cómodo

  • Volví a leer una entrada de blog que escribí hace unos meses, “SWEs want offline docs”: https://technicalwriting.tools/posts/offline-docs/
    ¿Existe alguna tecnología parecida a RSS que permita indicar que la documentación es apta para consumirse offline? No me refiero a algo como service workers, sino a un formato estandarizado que permita al usuario leer la documentación sin conexión
    Hasta ahora, lo único que he visto son PDF y sitios HTML independientes empaquetados en ZIP. ¿Habrá algo más? Es una idea todavía verde, pero me pregunto si ya existe algo y simplemente no lo conozco

    • No estoy seguro de que haya algo mejor que ZIP. Nuestro sitio web[0] contiene documentación de motores de juego, documentación de paquetes de Zig y demás, y en el footer tenemos un enlace a “offline version of this site” que ofrece un archivo ZIP de unos 80 MB
      La dificultad de ZIP es que no se adapta bien a si el usuario quiere todas las imágenes, la documentación de todas las versiones o solo una versión específica. Aun así, ZIP sigue pareciendo la mejor opción
      [0] https://machengine.org/
    • No es una respuesta completa, pero el estándar para documentación offline y texto para consumo local/offline es, ojalá fuera, Markdown. De todos modos, yo casi siempre escribo solo en Markdown, normalmente usando http://obsidian.md
      Lo más parecido que conozco a un servicio tipo RSS para descargar documentación es Dash for macOS - API Documentation Browser, Snippet Manager - Kapeli
    • CHM[0] es exactamente eso, pero está centrado en Windows. Aquí[1] hay un ejemplo de cómo se ve en el visor nativo
      Es una lástima que Microsoft lo haya abandonado, y algunos proyectos como AutoHotKey todavía lo usan
      [0] https://en.wikipedia.org/wiki/Microsoft_Compiled_HTML_Help
      [1] https://www.helpsmith.com/images/ss/chm-help1.png
    • He usado Zeal. Todavía no tiene todo, pero da bastante tranquilidad
    • Tal vez sea solo yo, pero la documentación Info de Emacs es realmente buena para este uso y no estorba

  • Estoy revisando una checklist antes de un viaje largo. Estoy descargando documentación de lenguajes y APIs por si quiero programar durante el vuelo, y quería compartir esta excelente herramienta
    Permite tener acceso offline fácilmente a mucha documentación de lenguajes y APIs. Pienso repasar un poco Zig y hacer algo divertido con Vulkan. Feliz Año Nuevo

  • Me resultó útil para programar en movimiento. Especialmente cuando el WiFi es inestable
    También me gusta que la documentación esté reunida en un solo lugar. Si man, MDN y DevDocs se unieran en una interfaz estándar, mi productividad aumentaría mucho

  • Me sorprende un poco que los programadores se dediquen a crear soluciones sistemáticas para problemas molestos, pero nuestras propias necesidades más básicas todavía no parecen estar bien resueltas
    Por ejemplo, en DevDocs faltan bastantes bibliotecas que uso con frecuencia, como los bindings de Selenium para Python. También probé Dash, pero no podía simplemente traer documentación como la de OpenAI, así que al final tenía que ir al sitio web
    Es decir, me quedaba sin las geniales funciones de Dash para buscar rápidamente contenido estructurado, lo cual me parece bastante irónico

  • Hace poco lo usé en un vuelo de 14 horas. Un día que iba a desperdiciarse se convirtió en uno increíblemente productivo.
    No había distracciones y, para las preguntas que surgían de vez en cuando, la documentación me daba la respuesta. También es realmente bueno cuando simplemente quieres desconectarte

    • Se ve muy bien. A veces, tener restricciones sobre lo que puedes hacer en realidad te da libertad.
      ¿Cuál sería la netbook Linux moderna? Quiero una maquinita con tan poca potencia para navegar la web que no te quede otra que concentrarte.
      Puede que las Chromebook hayan ocupado ese lugar, pero no quiero meter más Google en mi vida.

  • dedoc es una herramienta CLI offline para descargar, buscar y leer DevDocs desde la CLI. Es una buena forma de evitar el cambio de contexto al navegador, y también las distracciones del propio navegador.
    https://github.com/toiletbril/dedoc
    Está compilada estáticamente en Rust, así que basta con descargar e instalar el binario.

  • Parece un Dash (https://kapeli.com/dash) open source. Qué bien.

    • Ya existe un Dash open source (https://zealdocs.or). Pero no ofrece builds para Mac por un acuerdo sobre el uso de algunos catálogos de Dash.
      Aun así, puedes compilarlo tú mismo en Mac (https://github.com/zealdocs/zeal/wiki/Build-Instructions-for...)
    • Después de volver a Linux, extrañé muchísimo Dash. En mi lista de pendientes está hacer una réplica web y también quiero dar soporte a paquetes personalizados, que eran la función estrella de Dash.
      También me gustaría agregar una integración de primer nivel con Emacs para no tener que cambiar de contexto al navegador.
      Por ahora primero estoy lanzando otro proyecto, así que tendré que retomarlo después. Tener siempre una o dos pestañas de hexdocs.pm y MDN abiertas me ha pegado fuerte en la productividad.
    • También hay conjuntos de documentación aportados por usuarios, alojados por Dash: https://zealusercontributions.vercel.app/
    • Dash también puede importar documentación de readthedocs.org con muchísima facilidad, y DevDocs no tiene esa función.

  • Esto es excelente. Ojalá lo hubiera conocido antes.
    Cuando sabes que solo buscas resultados de documentación oficial, es mucho mejor que un motor de búsqueda web, y además es mucho más rápido. Estoy pensando en descargar una copia para ejecutarla localmente o alojarla.

  • Me encanta esta herramienta. La uso a diario mediante un paquete de Emacs[1], y me pareció que su flujo de trabajo es mucho más fluido que las soluciones tipo Dash.
    [1]: https://github.com/astoff/devdocs.el