Este texto fixa o padrão editorial da Base de Conhecimento: voz, notação, o cartão de capítulo e a política de referências. Aplicamos o mesmo cuidado às páginas em inglês e em português. Não é um manual de estilo de marketing, e não substitui o conteúdo substancial dos capítulos.

Aplicações na Keyne Digital Assets

A biblioteca é um dos materiais de orientação que usamos internamente e que publicamos no site. Este padrão descreve como essa biblioteca deve ser escrita e conservada. Não acrescenta um produto editorial ao Situation Monitor.

Padrão editorial

Edição: 2026-07-12 · Público: leitores técnicos e pesquisadores
Registro: português claro e preciso, sem uma muralha de jargão.

1. Voz e notação

Parágrafos curtos e definições numeradas

Evitar: Muros de itens indiferenciados

Nomes científicos padrão na primeira ocorrência, depois a forma curta

Evitar: Siglas indefinidas

Matemática inline $E = mc^2$ ou simplesmente E = mc²

Evitar: Tokens quebrados como $$ $Z$ $$

“Escrevemos…”, “Definimos…”, “Afirmação no estilo de um teorema:”

Evitar: Superlativos de marketing (“definitivo”, “revolucionário”)

Voz ativa e presente nas definições

Evitar: Preenchimento (“a fim de”, “é importante notar que”)

As definições seguem uma forma fixa:

Definição (Nome). Enunciado em uma ou duas frases.
Notação. Símbolos opcionais.
Exemplo. Um caso concreto.

2. Cartão de capítulo (no alto de cada capítulo)

Todo capítulo começa com:

Título (# …)
Rótulo da parte (Geral · Engenharia · Ciência da computação · Playbooks)
Em resumo — 3 a 6 itens com as afirmações centrais
Palavras-chave — separadas por vírgula
Referências online — URLs vivas da Wikipedia ou de fontes primárias
Instantâneos offline — capturas locais em .gitbook/assets/snapshots/, para que o texto sobreviva à quebra de links
Corpo — o conteúdo principal
Ver também — ligações internas
Termos de glossário introduzidos — chaves que apontam para GLOSSARY.md

3. Política de referências

Wikipedia

Regra: Ligar o EN (e o PT/FR quando for a fonte primária) + figura no estilo de um embed com captura e legenda = URL + data de coleta

Artigos / livros

Regra: Preferir DOI ou URL estável da editora + citação breve

GitHub

Regra: Raiz da organização/repositório + commit fixado, ou nota main, na legenda

Embeds sociais

Regra: Manter {% embed %} quando for útil; sempre acompanhar de um instantâneo offline quando a afirmação for de carga

Comando de captura (para quem mantém o arquivo):

CHROME="/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"
"$CHROME" --headless=new --disable-gpu --window-size=1280,1800 \
  --screenshot=docs/.gitbook/assets/snapshots/wiki-<slug>.png \
  "https://en.wikipedia.org/wiki/<Page>"

4. Simplicidade científica

Explicar como se ensina a um graduando atento:

Enunciar o objeto de estudo.
Dar a formalização mínima.
Dar uma intuição trabalhada.
Indicar onde está a literatura de fundo (ligações + instantâneos).

Não se remove profundidade dos capítulos longos; acrescenta-se estrutura (partes numeradas, caixas de definição, cruzamentos) em vez de apagar material.

5. Lista de completude (por capítulo)

[ ] Cartão de capítulo presente
[ ] Pelo menos uma ligação viva à Wikipedia (ou a uma fonte primária)
[ ] Pelo menos uma figura de instantâneo offline
[ ] Palavras-chave e chaves de glossário
[ ] Ver também: ao menos 2 ligações internas
[ ] Revisão de língua (sem entidades HTML quebradas no prosa, sem <a class="button"> vazio)
[ ] Notação matemática legível

Aplica-se a todos os caminhos sob docs/. Injeção assistida por máquina via os scripts de curadoria da biblioteca.