DevDocs, uma plataforma de documentação técnica

Introdução ao DevDocs

• DevDocs é um site que reúne diversas documentações de API em uma interface rápida, organizada e pesquisável.
• Os usuários podem ativar mais documentações e personalizar a interface por meio das configurações de preferência.
• É possível usar o site de forma eficiente com atalhos de teclado, sem precisar do mouse.

Recursos de busca

• A busca oferece suporte a correspondência difusa; por exemplo, ao digitar "bgcp", aparece "background-clip".
• Para pesquisar em uma documentação específica, basta digitar o nome ou a abreviação da documentação e pressionar a tecla Tab.
• Também é possível aprender a pesquisar usando a barra de endereços do navegador.

Informações adicionais

• O DevDocs funciona offline, pode ser usado no celular e pode ser instalado como aplicativo web.
• Para receber novidades, você pode seguir @DevDocs.
• O DevDocs é gratuito e disponibilizado como open source.
• Para quem está começando a programar, é recomendado conferir o currículo open source do freeCodeCamp.

Opinião do GN⁺

• DevDocs é uma ferramenta essencial para desenvolvedores, pois facilita encontrar em um só lugar documentações de várias linguagens de programação e frameworks.
• Os atalhos de teclado e a busca com correspondência difusa são recursos importantes que aumentam a eficiência dos desenvolvedores.
• O acesso offline e a compatibilidade com dispositivos móveis tornam o DevDocs ainda mais útil, permitindo que os usuários acessem informações de qualquer lugar.

[GN⁺]

Comentários do Hacker News

• Opinião de um dos mantenedores:

  • Atualizar a documentação para um novo release é fácil, a menos que o sistema ou o design da documentação sejam reescritos.
  • Alguns projetos mudam regularmente o sistema de documentação.
  • O gerador de documentação cria nomes de classes aleatórios, o que torna a organização da documentação trabalhosa.
  • Todo mês é gerada automaticamente uma lista de documentação desatualizada, e ele precisa de ajuda.

• Opinião de um usuário que revisitou um post de blog sobre documentação offline:

  • Ele se pergunta se existe alguma tecnologia que facilite o consumo de documentação offline.
  • Pergunta se há um formato padronizado ou algo que ele ainda não conhece.

• Opinião de um usuário que verifica uma checklist antes de uma viagem longa:

  • Compartilha ferramentas para acessar facilmente documentação de linguagens e APIs offline.
  • Está planejando desenvolver usando Zig e Vulkan.

• Opinião de um usuário que achou isso útil ao programar em deslocamento:

  • É especialmente útil quando o WiFi está instável.
  • Integrar a documentação em uma única interface padrão aumentaria muito a produtividade.

• Opinião de um usuário surpreso por uma necessidade básica dos programadores não ter sido atendida de forma sistêmica:

  • O devdocs não inclui bibliotecas que ele usa regularmente.
  • Ele tentou usar o Dash, mas não conseguiu obter diretamente a documentação da OpenAI.

• Opinião de um usuário que usou essa ferramenta durante um voo de 14 horas e conseguiu ter um dia produtivo:

  • É muito útil porque a documentação pode responder às perguntas sem distrações.

• Opinião de um usuário sobre a ferramenta CLI offline dedoc:

  • Evita a mudança de contexto para o navegador e permite baixar, pesquisar e ler o devdocs pela CLI.
  • É compilada estaticamente em Rust, então é possível baixar e instalar o binário.

• Opinião de um usuário sobre uma ferramenta open source semelhante ao Dash:

  • Muito boa.

• Opinião de agradecimento por esta ferramenta:

  • É muito melhor do que mecanismos de busca na web quando se quer encontrar resultados apenas na documentação oficial.
  • Ele pretende copiar e rodar localmente ou hospedar por conta própria.

• Opinião de um usuário que usa essa ferramenta diariamente por meio de um pacote do Emacs:

  • O fluxo de trabalho é muito mais suave em comparação com soluções como o Dash.