Automatização de documentação com Bido | Seja um desenvolvedor 10x | Bido AI
Tabela de conteúdos
- Introdução
- Automação de documentação
2.1. Uso do script create_doc.sh
2.2. Iteração através de pastas e arquivos
2.3. Criação de uma nova pasta de documentação
- Saída do processo de documentação
3.1. Criação de arquivos markdown
3.2. Sumário e detalhes de cada arquivo
3.3. Destaque de dependências e recursos externos
3.4. Prompt detalhado para documentar o código
- Utilização do Bido CLI
4.1. Requisitos e configuração
4.2. Planos e opções avançadas
4.3. Configuração do modelo básico ou avançado
- Conclusão
Automação de documentação para repositórios com Bido
📝 Introdução
Se você está à procura de uma solução eficiente para documentar automaticamente um repositório inteiro ou um conjunto de arquivos, o Bido tem a resposta para você. Neste artigo, vamos explorar as automações oferecidas pelo Bido e, em particular, o processo de documentação.
🤖 Automação de documentação
A automação de documentação é uma das funcionalidades mais interessantes disponíveis no Bido. Para começar, você precisará utilizar o script create_doc.sh
, que é fornecido como parte do projeto de automações do Bido. Esse script permite percorrer uma pasta específica e realizar a documentação de cada arquivo dentro dela.
📂 Uso do script create_doc.sh
Para utilizar o script de documentação, basta fornecer o nome da pasta que deseja documentar como argumento de entrada. Por exemplo, se você tiver uma pasta chamada "local_code_ai", poderá executar o comando ./create_doc.sh local_code_ai
para iniciar o processo de documentação.
O script irá criar uma nova pasta chamada "doc_local_code_ai" e gerar a documentação para cada arquivo presente na pasta fornecida.
📁 Iteração através de pastas e arquivos
Durante o processo de documentação, o script irá percorrer cada pasta e arquivo dentro da pasta fornecida. Ele busca arquivos com o nome "BCLI" e utiliza as informações neles contidas para gerar a documentação correspondente.
💡 Criação de uma nova pasta de documentação
A pasta de documentação, criada automaticamente pelo script, terá o nome "doc_local_code_ai". Dentro dessa pasta, você encontrará arquivos markdown contendo todas as informações necessárias para a documentação.
✍️ Saída do processo de documentação
Um dos principais resultados do processo de documentação é a geração de arquivos markdown. Esses arquivos contêm informações detalhadas sobre cada arquivo encontrado durante a iteração.
📝 Sumário e detalhes de cada arquivo
Cada arquivo documentado terá um sumário que permite identificar rapidamente o seu conteúdo. Além disso, os detalhes de cada arquivo são organizados, incluindo dependências, funções e comentários presentes no código.
🔍 Destaque de dependências e recursos externos
A documentação também destaca as dependências necessárias para o funcionamento de cada arquivo. Além disso, são fornecidos recursos externos relevantes que podem ser úteis durante o desenvolvimento.
💬 Prompt detalhado para documentar o código
Durante o processo de documentação, você terá acesso a um prompt detalhado que solicita informações sobre o código a ser documentado. Esse recurso sofisticado permite fornecer um resumo, detalhar dependências, classes, módulos, funções, casos especiais e assumir suposições relacionadas ao código.
🛠️ Utilização do Bido CLI
Para utilizar as automações oferecidas pelo Bido, você precisará ter instalado o Bido CLI em seu ambiente. Certifique-se de ter os requisitos necessários e siga as instruções de instalação fornecidas no GitHub do Bido.
💡 Requisitos e configuração
Além da instalação do Bido CLI, é importante ressaltar que, para arquivos mais extensos, é recomendável atualizar para o plano "10x Play" do Bido. Esse plano permite submeter arquivos completos com até 240.000 caracteres.
🏢 Planos e opções avançadas
O Bido possui diferentes planos disponíveis, incluindo opções avançadas para personalizar a utilização do CLI. Para conferir as configurações atuais do CLI, basta digitar o comando bido config DL
.
💻 Configuração do modelo básico ou avançado
É possível escolher entre o modelo básico e o modelo avançado para utilização do Bido CLI. Para alterar essa configuração, execute o comando bido config DL
e edite o arquivo de configuração para definir o modelo desejado.
🔚 Conclusão
Ficamos muito empolgados em apresentar a automação de documentação disponível no Bido. Esperamos que você aproveite essa funcionalidade e nos forneça seu feedback sobre a sua experiência. O Bido está sempre em busca de aprimoramentos para atender às suas necessidades. Experimente e deixe-nos saber o que você pensa!