Guia Operacional | Produzir e publicar edições do Compass™
Este guia descreve o passo a passo para produzir e publicar novas edições do Compass™, a base de conhecimento corporativa e de educação continuada do Grupo CSV, garantindo consistência editorial e integridade do conteúdo.
Passo 1 — Definir fonte primária
Identificar e obter o documento que será a base da edição. A fonte primária é o único material autorizado para extração de conteúdo. Nenhum fato, argumento, exemplo, número ou referência pode ser adicionado além do que consta na fonte.
Passo 2 — Garantir extração integral do texto
Extrair 100% do texto da fonte primária. Verificar que nenhum parágrafo, tabela, diagrama, citação ou referência foi omitido. Se a fonte for um PDF, confirmar que a extração capturou todas as páginas e todos os elementos textuais.
Passo 3 — Criar pasta da edição
Criar a estrutura de diretórios para a nova edição:
/compass/edicoes/AAAA/NNN/
compass.md
metadata.yml
/assets/
compass_header.png
compass_letterhead.pdfOnde AAAA é o ano e NNN é o número sequencial (ex.: 002, 003).
Copiar os assets compass_header.png e compass_letterhead.pdf para a pasta /assets/ da edição.
Se o hub utilizar um docs site (VitePress), criar também a versão correspondente em docs/compass/edicoes/AAAA/NNN/.
Passo 4 — Aplicar cabeçalho, numeração e título
Usar o template em /compass/templates/compass_template.md como base. Preencher:
- Edição (formato NNN/AAAA)
- Título (fiel à fonte primária, tecnicamente preciso, não apelativo)
- Data de publicação (data real do commit, não inventar data histórica)
- Status: Publicado
- Links para assets
Remover o bloco de "Regras do template" antes de publicar.
Passo 5 — Inserir texto integral e preservar referências
Inserir o texto completo da fonte primária no corpo do compass.md. Manter todas as citações e referências exatamente como estão na fonte. A única intervenção permitida é substituir ocorrências de "Parecer técnico executivo" (ou variações) pelo padrão Compass™.
Remover parâmetros de rastreamento de URLs (ex.: ?utm_source=...).
Passo 6 — Preencher metadados
Criar o arquivo metadata.yml usando o template em /compass/templates/metadata_template.yml. Preencher apenas com termos que apareçam explicitamente na fonte primária.
Passo 7 — Rodar checklist e publicar
Executar o checklist obrigatório abaixo. Todos os itens devem passar antes do commit.
Checklist obrigatório
- [ ] Texto integral presente (zero omissões)
- [ ] Zero referências ao processo de produção do documento (ferramentas, métodos de autoria)
- [ ] Zero ocorrências de "Parecer técnico executivo" (buscar no repositório)
- [ ] Numeração correta (formato NNN/AAAA)
- [ ] Cabeçalho Compass™ completo
- [ ] Links funcionam (Central para edição; edição para assets)
- [ ] Nenhuma adição de conteúdo fora da fonte primária
- [ ] Tom construtivo e não-confrontativo confirmado
- [ ] metadata.yml preenchido corretamente
- [ ] Versão VitePress criada (se aplicável)
Comandos de verificação
# Buscar termos proibidos
grep -rni "parecer técnico" compass/
grep -rni "gerado por" compass/
grep -rni "elaborado com" compass/
grep -rni "auxílio de" compass/
# Verificar links de assets
ls -la compass/edicoes/AAAA/NNN/assets/Passo 8 — Atualizar índice da Central
Adicionar a nova edição na tabela de edições em:
/compass/README.md(versão GitHub)/docs/compass/index.md(versão VitePress, se aplicável)
Incluir: número da edição, título e status.
Passo 9 — Commit e push
Fazer commit com mensagem descritiva:
feat(compass): publicar edição NNN/AAAA — [Título]Fazer push para a branch principal.
