rodolpho.lopes/knowledge-base
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Knowledge base do projeto GLPI11 — registros técnicos e padrões
3 commits 1 branch 0 tags 351 KiB
Python 99%
Makefile 1%
Find a file
Rodolpho Lopes 60060dce60 fix: adiciona front matter em KB-019/020 e sincroniza index.json 
KB-PLUGIN-019 e KB-PLUGIN-020 estavam sem delimitador YAML.
KB-PLUGIN-011, 017, 018 tinham divergencias no index.json (titulo, status, severity).
Todos corrigidos via kb_check.py --fix.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-26 20:21:25 +00:00
records fix: adiciona front matter em KB-019/020 e sincroniza index.json 2026-05-26 20:21:25 +00:00
schemas Initial commit — knowledge base migrada do dev local 2026-05-26 15:11:41 +00:00
.gitignore Initial commit — knowledge base migrada do dev local 2026-05-26 15:11:41 +00:00
index.json fix: adiciona front matter em KB-019/020 e sincroniza index.json 2026-05-26 20:21:25 +00:00
kb_check.py chore: move kb_check.py para dentro da knowledge-base 2026-05-26 20:19:54 +00:00
Makefile chore: move kb_check.py para dentro da knowledge-base 2026-05-26 20:19:54 +00:00
README.md Initial commit — knowledge base migrada do dev local 2026-05-26 15:11:41 +00:00

README.md

Base de Conhecimento para Agentes de IA

Esta base foi projetada para leitura eficiente por agentes e humanos.

Arquitetura recomendada

  • index.json: catalogo central para busca semantica rapida por agente.
  • records/: um registro por arquivo Markdown, com metadados em front matter YAML.
  • schemas/: contrato JSON Schema para validar metadados e manter consistencia.

Por que esse formato e eficiente

  • JSON para roteamento: agentes localizam o registro certo sem ler toda a base.
  • Markdown para contexto: explica causa, impacto e procedimento com baixa ambiguidade.
  • Metadados padronizados: permite filtro por tags, severity, domain e status.
  • Versionamento simples: cada incidente vira um arquivo independente e auditavel no Git.

Convencao de registros

  • ID: KB-<DOMINIO>-NNN (ex.: KB-INFRA-001)
  • Nome de arquivo: <ID>-<slug>.md
  • Campos obrigatorios de metadados:
    • id
    • title
    • domain
    • tags
    • status
    • severity
    • created_at
    • updated_at
    • applies_to

Fluxo de atualizacao

  1. Criar novo registro em records/<dominio>/.
  2. Atualizar index.json com resumo e caminho.
  3. Validar aderencia ao schema em schemas/.
  4. Referenciar o registro em documentacao operacional quando necessario.

Validacao automatica

Use:

make kb-check
make kb-fix

A verificacao valida:

  • metadados obrigatorios conforme schema;
  • padrao de ID de registro;
  • sincronizacao entre index.json e arquivos em records/.

make kb-fix faz ajustes automaticos no index.json:

  • inclui registros faltantes;
  • remove entradas orfas;
  • sincroniza campos principais;
  • atualiza last_updated.