Primeiros Passos

Para Agentes de IA

Como agentes de IA podem consumir e utilizar este repositório.

Identificação do Projeto

IMPORTANTE: Esta seção contém informações essenciais para agentes de IDE identificarem rapidamente o tipo e propósito deste repositório.

Tipo de Projeto

  • Categoria: Base de conhecimento estruturada em Markdown
  • Propósito: Ser consumida por agentes de IA em IDEs e ferramentas de desenvolvimento
  • Formato: Documentação estática em Markdown com metadados YAML

Idioma

  • Idioma principal: Português do Brasil (pt-BR)
  • Convenção: Todo o conteúdo, nomes de arquivos e documentação estão em português brasileiro

Estrutura Principal

  • Diretório de conteúdo: content/
  • Arquivo de entrada principal: content/index.md
  • Formato de arquivos: .md (Markdown) com frontmatter YAML
  • Organização: Diretórios numerados (ex: 1.primeiros-passos/, 2.essentials/)

Metadados

  • Frontmatter: Cada arquivo .md contém metadados YAML no início
  • Campos essenciais: title, description, navigation
  • Formato: YAML entre --- no início do arquivo

Convenções de Nomenclatura

  • Arquivos numerados: Prefixo numérico para ordenação (ex: 1., 2., 3.)
  • Nomes em português: Todos os nomes de arquivos em português do Brasil
  • Separador: Hífens para espaços (ex: para-agentes-ia.md, manutencao-conteudo.md)

Identificadores Rápidos

  • README.md: Contém visão geral e propósito do repositório
  • package.json: Contém metadados do projeto (nome, descrição, repositório)
  • .cursorrules: Arquivo na raiz com instruções específicas para agentes de IDE

Visão Geral

Este repositório foi projetado especificamente para ser consumido por agentes de IA que operam em IDEs e ferramentas de desenvolvimento. O conteúdo está estruturado de forma a facilitar a compreensão, busca e processamento por sistemas de IA.

Como Consumir o Conteúdo

1. Estrutura de Diretórios

O repositório está organizado hierarquicamente:

content/
├── index.md                    # Página inicial com visão geral
├── 1.primeiros-passos/          # Documentação introdutória
│   ├── 1.para-agentes-ia.md   # Este arquivo
│   ├── 2.introducao.md        # Introdução geral
│   └── ...
└── 2.essentials/               # Conteúdo essencial
    ├── 1.sintaxe-markdown.md  # Sintaxe Markdown
    └── ...

Padrão de numeração: Os arquivos são prefixados com números para manter ordem de navegação (ex: 1., 2., 3.).

2. Metadados Frontmatter

Cada arquivo Markdown contém metadados em formato YAML no início:

---
title: Título da Página
description: Descrição breve do conteúdo
navigation:
  icon: i-lucide-icon-name
  order: 1
seo:
  title: Título SEO
  description: Descrição para SEO
---

Campos importantes para agentes de IA:

  • title: Título principal do documento
  • description: Resumo do conteúdo
  • navigation.order: Ordem de exibição (quando presente)

3. Estrutura de Conteúdo

Títulos Hierárquicos

Use a hierarquia de títulos para entender a estrutura:

  • # - Título principal (H1) - geralmente o mesmo do frontmatter
  • ## - Seções principais (H2)
  • ### - Subseções (H3)
  • #### - Sub-subseções (H4)

Blocos de Código

Blocos de código são identificados por três backticks seguidos do nome da linguagem:

```typescript
const exemplo = "código aqui";
```

Importante: O nome da linguagem após os backticks ajuda a identificar o contexto do código.

Links para outros documentos usam caminhos relativos:

[Texto do link](/caminho/para/arquivo)

4. Busca e Navegação

Busca Semântica

Ao buscar informações, considere:

  1. Títulos e subtítulos: Contêm palavras-chave importantes
  2. Descrições no frontmatter: Resumem o conteúdo do arquivo
  3. Conteúdo dos parágrafos: Contexto detalhado
  4. Blocos de código: Exemplos práticos
  • Use a estrutura de diretórios para entender relacionamentos
  • Links internos indicam documentos relacionados
  • A ordem numérica dos arquivos indica sequência lógica

Boas Práticas para Agentes de IA

1. Leitura Contextual

  • Leia o frontmatter primeiro: Fornece contexto sobre o documento
  • Respeite a hierarquia: Títulos indicam importância e relacionamento
  • Considere o contexto do diretório: Arquivos em primeiros-passos/ são introdutórios

2. Processamento de Código

  • Identifique a linguagem: O nome após os backticks indica a sintaxe
  • Preserve formatação: Espaçamento e indentação são importantes
  • Considere exemplos completos: Blocos de código podem ser exemplos funcionais
  • Links internos: Apontam para outros documentos do repositório
  • Links externos: Apontam para recursos externos (geralmente começam com http:// ou https://)
  • Links relativos: Use o caminho do arquivo atual como base

4. Extração de Informações

Ao extrair informações:

  1. Priorize títulos e descrições: Contêm informações resumidas
  2. Use listas: Itens em listas são pontos-chave
  3. Identifique blocos de código: Podem conter exemplos práticos
  4. Considere tabelas: Dados estruturados em formato tabular

Estrutura de Metadados Recomendada

Ao processar documentos, extraia e utilize:

  • Título principal: Do frontmatter title ou H1
  • Descrição: Do frontmatter description
  • Seções principais: Todos os H2 (##)
  • Subseções: H3 (###) quando relevante
  • Links relacionados: Links internos e externos
  • Exemplos de código: Blocos de código com contexto

Exemplo de Processamento

Ao encontrar uma pergunta ou necessidade de informação:

  1. Identifique palavras-chave na consulta
  2. Busque em títulos e descrições primeiro
  3. Navegue pela estrutura se necessário
  4. Extraia contexto relevante incluindo exemplos de código
  5. Forneça referências aos documentos consultados

Lidando com Erros Gramaticais e Digitação

Agentes de IA devem estar preparados para interpretar e lidar com erros gramaticais, erros de digitação e frases incompletas nas interações com usuários. A capacidade de inferir a intenção do usuário mesmo com imperfeições na comunicação é essencial para uma experiência fluida.

Princípios Gerais

  • Inferir intenção: Priorize entender o que o usuário quer dizer, mesmo com erros
  • Manter contexto: Use o contexto da conversa e do projeto para interpretar mensagens
  • Não interromper o fluxo: Pequenos erros não devem bloquear o progresso do trabalho
  • Ser tolerante: Erros de digitação são comuns e esperados em comunicação humana

Situações Comuns

Frases Incompletas

Quando uma frase está incompleta (ex: "além disso" sem continuação), o agente deve:

  1. Analisar o contexto: Verificar o que foi discutido anteriormente
  2. Inferir a intenção: Tentar entender o que o usuário provavelmente queria dizer
  3. Continuar o trabalho: Prosseguir com a tarefa baseado na inferência
  4. Confirmar se necessário: Se a inferência for muito incerta, pedir confirmação

Exemplo: Se o usuário diz "além disso, inclua..." e a mensagem é cortada, mas o contexto anterior indica uma tarefa em andamento, o agente deve inferir que o usuário quer adicionar algo relacionado à tarefa atual.

Erros de Digitação

Erros comuns incluem:

  • Troca de letras (ex: "digitação" → "digitaçao")
  • Palavras incompletas (ex: "instala" → "instal")
  • Erros de acentuação (ex: "instalação" → "instalacao")
  • Palavras cortadas (ex: "além disso" → "além dis")

O agente deve:

  • Reconhecer variações: Identificar palavras mesmo com erros comuns
  • Usar contexto: O contexto ajuda a identificar palavras mal escritas
  • Não corrigir desnecessariamente: Focar em entender, não em corrigir

Erros Gramaticais

Erros gramaticais podem incluir:

  • Concordância incorreta
  • Ordem de palavras alterada
  • Pontuação ausente ou incorreta

O agente deve:

  • Priorizar significado: Entender o significado mesmo com erros gramaticais
  • Manter foco na tarefa: Não se distrair com correções gramaticais desnecessárias
  • Ser flexível: Aceitar diferentes formas de expressão

Quando Pedir Esclarecimento

Peça esclarecimento apenas quando:

  1. A intenção é completamente ambígua: Não há contexto suficiente para inferir
  2. Há múltiplas interpretações igualmente prováveis: Várias opções fazem sentido
  3. A tarefa é crítica: Erros podem ter consequências significativas
  4. O usuário explicitamente pede confirmação: O usuário quer garantir que entendeu

Quando Inferir

Inferir a intenção quando:

  1. O contexto é claro: A conversa anterior fornece contexto suficiente
  2. A tarefa é rotineira: É uma operação comum e previsível
  3. O erro é óbvio: É fácil identificar o que o usuário quis dizer
  4. A inferência é segura: Há alta probabilidade de estar correto

Boas Práticas

  • Sempre considerar o contexto completo: Não apenas a mensagem atual
  • Ser proativo: Não esperar perfeição na comunicação
  • Manter a fluidez: Priorizar continuidade sobre perfeição
  • Aprender com padrões: Reconhecer padrões de comunicação do usuário
  • Ser paciente: Erros são parte natural da comunicação humana

Exemplo Prático

Situação: Usuário escreve "além disso, inclua, nos documentos, instruções para os agentes se prepararem para situações como essa de erro gramatical/digitação"

Análise do agente:

  • Contexto: Discussão sobre atualização de documentação
  • Intenção inferida: Adicionar instruções sobre erros gramaticais nos documentos
  • Ação: Prosseguir com a tarefa de adicionar a seção solicitada

Resultado: O agente entende a intenção mesmo com a frase inicialmente incompleta ("além disso" sem continuação) e prossegue com a tarefa baseado no contexto completo.

Notas Importantes

  • Todo o conteúdo está em português do Brasil: Mantenha respostas e interpretações neste idioma
  • Estrutura pode evoluir: Novos documentos podem ser adicionados seguindo os padrões estabelecidos
  • Consistência é importante: Padrões de formatação facilitam processamento automático
  • Contexto é rei: Sempre considere o contexto do diretório e seção ao interpretar conteúdo
  • Tolerância a erros: Seja flexível com erros gramaticais e de digitação, priorizando a compreensão da intenção