DevDocs: plataforma de documentação para pesquisar vários documentos técnicos em um só lugar

 (devdocs.io)
3 pontos por GN⁺ 2024-01-14 | 1 comentários | Compartilhar no WhatsApp
  • Reúne em um só lugar a documentação de APIs que desenvolvedores consultam com frequência, permitindo buscas rápidas e reduzindo o custo de alternar entre documentações de diferentes linguagens e frameworks
  • Por padrão, exibe CSS, HTML, HTTP, JavaScript e Web APIs, e em Preferences é possível ativar mais documentações e ajustar a tela conforme a necessidade
  • Com fuzzy matching para encontrar background-clip usando bgcp e com definição do escopo de busca por documentação, fica mais fácil chegar rapidamente ao item desejado
  • Oferece suporte a atalhos de teclado, busca pela barra de endereço do navegador, uso em dispositivos móveis e instalação como aplicativo web
  • É possível visualizar a documentação também offline, e por ser um projeto open source gratuito, pode ser usado sem dificuldade em diferentes ambientes de desenvolvimento

Pesquise vários documentos de API em um só lugar

  • DevDocs combina várias documentações de API em uma interface de busca única, rápida e organizada
  • A tela inicial exibe as documentações de CSS, HTML, HTTP, JavaScript e Web APIs
  • Em Preferences, é possível ativar mais documentações e fazer customização da UI

Como funcionam a busca e a navegação

  • A busca oferece suporte a fuzzy matching
    • Por exemplo, ao digitar bgcp, é possível encontrar background-clip
  • Quando quiser pesquisar apenas dentro de uma documentação específica, digite o nome do documento ou sua abreviação e depois use Tab para limitar o escopo da busca
  • Também é possível usar a busca pela barra de endereço do navegador; as instruções de configuração estão disponíveis no guia

Uso centrado no teclado

  • É possível navegar e pesquisar sem usar o mouse
  • Consulte a lista de atalhos de teclado ou pressione ? para ver os atalhos disponíveis

Suporte offline e instalação

  • O DevDocs também funciona offline
  • Pode ser usado no celular e instalado como aplicativo web

Projeto open source gratuito

Leituras relacionadas

1 comentários

 
GN⁺ 2024-01-14
Opiniões no Hacker News

  • Sou um dos poucos mantenedores do DevDocs
    Atualizar a documentação para novos lançamentos é fácil, a menos que o sistema de documentação ou o design mude por completo. Mas alguns projetos parecem fazer essas reformulações com bastante frequência, como no redesign do react.dev
    Alguns geradores de documentação criam nomes de classes aleatórios, como .gtWOdv, .ezMiXD, .gOhcvK, que o Gatsby gera em docs.npmjs.com, tornando trabalhos como remover conteúdo desnecessário, como a navegação da página, trabalhosos e instáveis
    Todo mês gero automaticamente uma lista de documentações desatualizadas, e a lista mais recente está aqui: https://github.com/freeCodeCamp/devdocs/issues/2105
    Ajuda é sempre bem-vinda

    • simon04, o trabalho que os mantenedores fizeram há muito tempo fez uma grande diferença na minha carreira e, mais tarde, também na minha vida
      Poder ler documentação offline no trajeto de ida e volta do trabalho enquanto eu tocava um projeto de software urgente foi realmente importante
      Talvez vocês não tenham ganhado nem um centavo ajudando o devdocs, mas quero que saibam que estão ajudando pessoas de verdade
    • Este app é pessoalmente bastante frustrante para mim. É uma das melhores fontes de documentação, mas ficou quase inutilizável porque não consegue manter a lista de documentações que selecionei
      Quase toda vez que entro, preciso escolher de novo, do zero, a stack que uso. É excelente, mas não excelente o bastante para eu ficar repetindo isso sempre
      Não tenho problemas com cookies ou armazenamento local desaparecendo em outros lugares, e uso o Chrome mais recente no Linux. Alguma ideia do que possa estar causando isso?
    • Você poderia avaliar os geradores de documentação pelo quanto são fáceis de consumir?
      Gostaria de saber como Sphinx, Docsy, MkDocs, Docbook etc. se comparam em termos de facilidade de extração semântica
    • Em uma entrevista técnica, me perguntaram como eu faria XYZ com determinado framework
      Respondi que não sabia exatamente, mas que procuraria a interface da API no devdocs.io para entender melhor
      O entrevistador não entendeu o que eu queria dizer, então abriu no próprio notebook e ficou bem impressionado
      Claro que não consegui o emprego, mas foi bem legal disseminar conhecimento para o outro lado da mesa de entrevista
    • É graças a contribuições como essa que este site continua vivo e, como resultado, fiquei com vontade de apresentar algumas das minhas atualizações favoritas desde o Python 3.8
      Eu poderia ter encontrado os dados por conta própria, mas ele torna muito conveniente comparar por versão

  • Revi um post de blog que escrevi há alguns meses, “SWEs want offline docs”: https://technicalwriting.tools/posts/offline-docs/
    Existe alguma tecnologia parecida com RSS que possa indicar que a documentação é adequada para consumo offline? Não estou falando de algo como service workers, mas de um formato padronizado que permita ao usuário ler a documentação offline
    Até agora, o que vi se resume a PDFs e sites HTML independentes empacotados em ZIP. Existe algo diferente? É uma ideia ainda pouco amadurecida, mas fico curioso se isso já existe e eu é que não sei

    • Não sei bem se há algo melhor que ZIP. Nosso site[0] inclui documentação de engine de jogos, documentação de pacotes Zig etc., e colocamos no rodapé um link para “offline version of this site”, oferecendo um arquivo ZIP de cerca de 80 MB
      A dificuldade do ZIP é que é difícil atender a preferências como se o usuário quer todas as imagens, a documentação de todas as versões ou apenas uma versão específica. Ainda assim, ZIP continua parecendo a melhor opção
      [0] https://machengine.org/
    • Não é uma resposta completa, mas o padrão para documentação offline e textos para consumo local/offline é, ou eu gostaria que fosse, Markdown. De qualquer forma, quase sempre escrevo somente em Markdown, geralmente usando http://obsidian.md
      O mais próximo que conheço de um serviço parecido com RSS para baixar documentação é o Dash for macOS - API Documentation Browser, Snippet Manager - Kapeli
    • CHM[0] é exatamente isso, mas é centrado em Windows. Há um exemplo aqui[1] de como ele aparece no visualizador nativo
      É uma pena que a Microsoft tenha abandonado, e alguns projetos, como AutoHotKey, ainda usam
      [0] https://en.wikipedia.org/wiki/Microsoft_Compiled_HTML_Help
      [1] https://www.helpsmith.com/images/ss/chm-help1.png
    • Tenho usado o Zeal. Ainda não tem tudo, mas me deixa bem mais tranquilo
    • Talvez seja só comigo, mas a documentação Info do Emacs é realmente ótima para esse uso e não atrapalha

  • Estou passando por uma checklist antes de uma viagem longa. Estou baixando documentação de linguagens e APIs para o caso de querer desenvolver durante o voo, e quis compartilhar esta excelente ferramenta
    Ela permite acesso offline fácil à documentação de muitas linguagens e APIs. Estou pensando em revisar um pouco de Zig e fazer algo divertido com Vulkan. Feliz Ano Novo

  • Foi útil para programar em deslocamento. Especialmente quando o WiFi está instável
    Também gosto de ter a documentação reunida em um só lugar. Se man, MDN e DevDocs fossem combinados em uma única interface padrão, acho que a produtividade aumentaria bastante

  • Programadores têm como trabalho criar soluções sistemáticas para problemas irritantes, então acho um pouco surpreendente que nossas próprias necessidades mais básicas ainda não tenham sido bem resolvidas
    Por exemplo, no DevDocs faltam várias bibliotecas que uso com frequência, como os bindings do Selenium para Python. Também experimentei o Dash, mas não consegui simplesmente importar algo como a documentação da OpenAI, então acabei tendo que ir ao site
    Ou seja, fico privado dos ótimos recursos do Dash para pesquisar rapidamente conteúdo estruturado, o que me parece bastante irônico

  • Usei isso recentemente em um voo de 14 horas. Um dia que teria sido desperdiçado virou um dia extremamente produtivo
    Não havia distrações, e a documentação respondia às perguntas que surgiam de vez em quando. Também é muito bom quando você simplesmente quer se desconectar

    • Parece muito bom mesmo. Às vezes, ter restrições sobre o que dá para fazer acaba dando liberdade
      Qual seria o netbook Linux moderno? Quero uma maquininha pequena, com desempenho baixo demais para navegar na web, obrigando a pessoa a se concentrar
      O Chromebook talvez tenha ocupado esse espaço, mas não quero colocar mais Google na minha vida

  • dedoc é uma ferramenta CLI offline para baixar, pesquisar e ler o DevDocs pelo terminal. É uma boa forma de evitar a troca de contexto para o navegador, e também as distrações do próprio navegador
    https://github.com/toiletbril/dedoc
    Como é compilado estaticamente em Rust, basta baixar o binário e instalar

  • Parece um Dash(https://kapeli.com/dash) open source. Legal

    • Já existe um Dash open source(https://zealdocs.or). Só que, por causa de um acordo para usar parte dos catálogos do Dash, eles não oferecem build para Mac
      Mesmo assim, dá para compilar no Mac por conta própria(https://github.com/zealdocs/zeal/wiki/Build-Instructions-for...)
    • Depois que voltei para Linux, senti muita falta do Dash. Na minha lista de tarefas está criar uma réplica baseada na web, e também quero dar suporte a pacotes personalizados, que eram o recurso matador do Dash
      Também quero incluir uma integração de primeira linha com Emacs, para não precisar trocar de contexto para o navegador
      Por enquanto estou lançando outro projeto primeiro, então vou ter que retomar isso depois. Ter sempre uma ou duas abas do hexdocs.pm e da MDN abertas reduziu bastante minha produtividade
    • Também há conjuntos de documentação contribuídos por usuários, hospedados pelo Dash: https://zealusercontributions.vercel.app/
    • O Dash também consegue importar com muita facilidade a documentação do readthedocs.org, mas o DevDocs não tem esse recurso

  • Isto é excelente. Gostaria de ter conhecido antes
    Quando você sabe que está procurando apenas resultados da documentação oficial, é muito melhor que um mecanismo de busca da web, e também muito mais rápido. Estou pensando em baixar uma cópia e executá-la localmente ou hospedá-la

  • Gosto desta ferramenta. Uso diariamente com um pacote do Emacs[1], e achei que o fluxo de trabalho é muito mais fluido do que nas soluções do tipo Dash
    [1]: https://github.com/astoff/devdocs.el