Anotae — Documentação¶

A documentação do Anotae segue o framework Diátaxis (https://diataxis.fr/), organizada em 4 categorias complementares:

Estrutura¶

docs/
├── tutorials/      # "Aprenda fazendo" — guias passo-a-passo para iniciantes
├── how-to/         # "Como resolver problema X" — receitas para tarefas específicas
├── reference/       # "Referência técnica completa" — API, schema, configuração
└── explanation/     # "Por que decidimos assim" — contexto, ADRs, trade-offs

tutorials/¶

Guias passo-a-passo que levam o leitor de zero a um resultado concreto.

primeiro-atendimento.md — registrar o primeiro encounter SOAP.
exportar-relatorio.md — gerar XLSX para relatórios SUS.
usar-meus-numeros.md — explorar o dashboard de produção (Ctrl+J).

how-to/¶

Receitas para resolver problemas específicos.

backup-restaurar.md — criar, verificar e restaurar backups (GUI, CLI, manual).
configurar-extensao.md — instalar a extensão MV3 nos navegadores.
enviar-feedback.md — enviar feedback via mailto pré-formatado (sem PII).
extrair-campos-de-formulario.md — scripts/extract-form-fields.py.
integracao-sei-df.md — fluxo completo APS/DF → SEI/DF.

reference/¶

Documentação técnica completa: API interna, schema do banco, formato de mensagens NMH, configurações TOML.

cli.md — referência completa de subcomandos da CLI.
atalhos-de-teclado.md — tabela completa de atalhos.
schema.md — schema do vault SQLite gerado a partir das migrations (não editar à mão).
ANOTAE-DOCUMENTACAO-COMPLETA.md — visão consolidada.
../THREAT-MODEL.md — STRIDE + LINDDUN com 43 ameaças catalogadas.

explanation/¶

Contexto e justificativas: ADRs (Architecture Decision Records), trade-offs aceitos, decisões de design. Ajuda a entender por que as coisas são como são.

arquitetura.md — visão de componentes e camadas.
extensao-key-id.md — por que a key MV3 é fixa.
postura-integracao.md — princípios éticos da integração com sistemas SUS.
decisoes-de-ux-2026-05.md — ADR consolidado dos PRs #17–#21.
release-attestations.md — modelo Sigstore (PEP 740) + comparativo Authenticode.
mapping-plugins.md — sistema de plugins de mapping (built-in / user / custom).
i18n-roadmap.md — fases de internacionalização (v0.x → v4.0+).
perf-baseline-ci.md — modelo de baseline de performance em CI matrix.
bus-factor.md — por que precisamos de co-mantenedores (bus factor=1).
auditoria-checklist.md — mapeamento das 43 ameaças do threat model para evidência (arquivo, teste, comando) — pronto para auditor externo.

Idioma¶

Documentação primária em português brasileiro (público-alvo). Tradução para inglês em v4.0+.

Como contribuir¶

Veja CONTRIBUTING.md para padrões e workflow.