autodocAI.md

@@ -2,13 +2,13 @@
 
 ## 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 bito.ai 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.
+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 devem estar prontos e configurados para a execução automatizada.
+- **Scripts de Automação**: Scripts utilizados para automação da geração da documentação.
 
 ## Instalação e Configuração
 
@@ -17,11 +17,12 @@ Este documento descreve o procedimento para a geração automatizada de document
 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:
-     ```bash
+
+     ```shell
      bito config --setup
      ```
 
@@ -30,13 +31,14 @@ Este documento descreve o procedimento para a geração automatizada de document
 1. **Instalação do CLI**:
    - Certifique-se de que o CLI está instalado e disponível no PATH do seu sistema.
    - Verifique a instalação com o comando:
-     ```bash
+
+     ```shell
      bito --version
      ```
-
 2. **Configuração do CLI**:
    - Configure o CLI para se conectar ao bito.ai com suas credenciais:
-     ```bash
+
+     ```shell
      bito configure --auth
      ```
 
@@ -46,7 +48,7 @@ Este documento descreve o procedimento para a geração automatizada de document
 
 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:
 
-```bash
+```shell
 #!/bin/bash
 
 # Script de Geração de Documentação
@@ -60,3 +62,4 @@ CONFIG_FILE="/caminho/para/configuracao.json"
 bito generate --config $CONFIG_FILE --output $OUTPUT_PATH
 
 echo "Documentação gerada com sucesso!"
+```
\ No newline at end of file