DevDocs

Artigo original ↗ Discussão no Hacker News ↗

Desenvolvedores destacam o DevDocs.io como um navegador de documentação rápido, consolidado e com capacidade offline, que aumenta significativamente a produtividade, especialmente em conexões instáveis ou voos longos. Eles o comparam a ferramentas como Dash e Zeal, discutem integrações com editores e frontends de CLI, e apontam lacunas como a ausência de docs de C# devido a preocupações de licenciamento. A conversa se amplia para a importância de documentação offline de fácil acesso para software open source, os trade-offs em formatos e geradores de documentação, e como ferramentas emergentes como LLMs podem complementar ou eventualmente remodelar a forma como o conhecimento técnico é consumido.

Sentimento geral e casos de uso

  • Muitos comentaristas dizem que dependem do DevDocs há anos e o mantêm fixado ou integrado ao fluxo de trabalho.
  • O acesso offline é destacado como crítico em aviões, com Wi‑Fi instável e em configurações livres de distração; vários relatam ser mais produtivos offline com DevDocs + ferramentas/LLMs locais.
  • Alguns desenvolvedores dizem que praticamente não codificam sem internet (Google, MDN, ChatGPT), então documentação offline parece menos essencial para eles.

Comparações e alternativas

  • Frequentemente comparado ao Dash (macOS) e ao Zeal (open source, multiplataforma); o DevDocs é visto como uma alternativa aberta, com foco na web.
  • Usuários valorizam a capacidade do Dash de obter conteúdo do ReadTheDocs e docsets contribuídos por usuários; observa-se que o DevDocs não tem parte disso.
  • Outras ferramentas mencionadas: dedoc (CLI para DevDocs), devdocs-desktop, plugins para Vim/Neovim/Emacs, docsets do Zeal contribuídos por usuários, navegadores locais como CHM, GNU info, páginas man.

Formatos e padrões de documentação offline

  • Discussão sobre formatos de empacotamento para documentação offline: sites estáticos em ZIP, Markdown, AsciiDoc, “docsets” do Dash, GNU info, ePub, CHM.
  • Trade-offs observados: imagens vs tamanho, documentação por versão, sites muito dependentes de JS sendo mais difíceis de espelhar, e navegadores abandonando suporte a alguns formatos.
  • Alguns querem uma forma padronizada, semelhante ao RSS, para anunciar documentação “amigável ao offline”; não foi identificado nada amplamente adotado.

Recursos, lacunas e problemas técnicos do DevDocs

  • Apreciado pela velocidade, pesquisa unificada em muitas APIs/linguagens e modo offline.
  • Pedidos por mais ecossistemas: C#, Playwright, SDKs móveis/de SO, Common Lisp, confusão sobre Java (presente como “OpenJDK”).
  • A documentação de C#/.NET é limitada por supostos problemas de licenciamento, embora outros apontem para docs da Microsoft com licença CC e repositórios no GitHub.
  • Reclamações: Firefox e alguns navegadores ejetam o armazenamento offline; reinicializações do local storage podem apagar conjuntos de documentação selecionados.
  • O mantenedor explica que as docs são extraídas de HTML; sites muito dependentes de JS e CSS com nomes aleatórios complicam a extração e a limpeza; relatórios de documentação desatualizada são gerados mensalmente.

Debate filosófico: documentação offline, abertura e LLMs

  • Um longo subfio argumenta que o acesso offline fácil à documentação completa deveria ser considerado tão fundamental quanto a disponibilidade do código em FOSS.
  • Outros respondem que:
    • O problema maior é a qualidade da documentação, não apenas o acesso offline.
    • Muitos usuários serão melhor atendidos por UIs intuitivas do que por documentação.
    • LLMs estão cada vez mais respondendo perguntas mais rápido do que a documentação tradicional, potencialmente reduzindo a importância de longo prazo de ferramentas como o DevDocs.