Procedimento de Geração de Documentação Automatizada com bito.ai

Visão Geral

Este documento descreve o procedimento para a geração automatizada de documentação utilizando a ferramenta bito.ai, com ênfase no uso de CLI e scripts de automação. A ferramenta permite a criação de documentação técnica de forma eficiente e padronizada, facilitando a manutenção e a atualização contínua dos documentos utilizando Inteligência Artificial Generativa.

Requisitos

• bito.ai: A ferramenta bito.ai deve estar instalada e configurada no ambiente de desenvolvimento.
• CLI (Command Line Interface): O CLI deve estar acessível para execução de comandos.
• Scripts de Automação: Scripts utilizados para automação da geração da documentação.

Instalação e Configuração

Instalação do bito.ai

1. Download e Instalação:
   • Baixe o instalador apropriado para o seu sistema operacional a partir do site oficial do bito.ai.
   • Execute o instalador e siga as instruções na tela para concluir a instalação.
   • Para geração da documentação utilizou-se sistema operacional Linux Ubuntu por questões de facilidade no aproveitamento de alguns scripts de automação já disponiblizados pela comunidade.
2. Configuração Inicial:

   • Após a instalação, configure o bito.ai com suas credenciais e preferências pessoais.

   • Execute o comando de configuração inicial:

     bito config --setup

Criação das Credenciais do bito.ai

1. Criação de Conta:

   • Acesse o site do bito.ai e registre-se para criar uma conta, se ainda não tiver uma.
   • Complete o processo de registro e verifique seu e-mail para ativar sua conta.

2. Geração de Chave API:

   • Faça login no painel de controle do bito.ai.
   • Navegue até a seção de Configurações de API ou Credenciais.
   • Clique em Criar Nova Chave API.
   • Defina um nome para a chave e selecione as permissões necessárias.
   • Copie a chave API gerada e guarde-a em um local seguro. Você precisará dessa chave para configurar o CLI.

3. Configuração do CLI com a Chave API:

   • Execute o comando de configuração do CLI com a chave API:

     bito configure --auth --api-key YOUR_API_KEY

   • Substitua YOUR_API_KEY pela chave API copiada.

Criação e Execução de Scripts de Automação

Estrutura dos Scripts

Os scripts de automação devem seguir uma estrutura padrão para garantir a consistência na geração de documentação. Um exemplo básico de script pode ser:

#!/bin/bash

# Script de Geração de Documentação

# Definição das variáveis
DOCUMENTATION_PATH="/caminho/para/documentacao"
OUTPUT_PATH="/caminho/para/saida"
CONFIG_FILE="/caminho/para/configuracao.json"

# Comando para gerar a documentação
bito generate --config $CONFIG_FILE --output $OUTPUT_PATH

echo "Documentação gerada com sucesso!"