Ir para o conteúdo

Camadas Documentais

A documentação da empresa é organizada em 10 camadas, separadas por escopo, audiência e cadência de atualização. Cada camada tem finalidade distinta e pode ter visibilidade diferente (interna / pública / para clientes).


Mapa das Camadas

┌─────────────────────────────────────────────────────┐
│  CAMADA 1: CORPORATE                                │
│  Visão, missão, estratégia, estrutura               │
├─────────────────────────────────────────────────────┤
│  CAMADA 2: GOVERNANCE                               │
│  Políticas, processos, ADRs, decisões               │
├─────────────────────────────────────────────────────┤
│  CAMADA 3: PRODUCT                                  │
│  Service records, SLA, SLO, roadmap de produto      │
├─────────────────────────────────────────────────────┤
│  CAMADA 4: API                                      │
│  OpenAPI, README, auth, erros, versionamento        │
├─────────────────────────────────────────────────────┤
│  CAMADA 5: DATA                                     │
│  Sources, datasets, fields, provenance, quality     │
├─────────────────────────────────────────────────────┤
│  CAMADA 6: SERVICE MANAGEMENT                       │
│  Incidents, changes, releases, continuity           │
├─────────────────────────────────────────────────────┤
│  CAMADA 7: SECURITY                                 │
│  Security policy, access control, vuln management  │
├─────────────────────────────────────────────────────┤
│  CAMADA 8: PRIVACY / LEGAL                          │
│  LGPD, terms of service, data licenses              │
├─────────────────────────────────────────────────────┤
│  CAMADA 9: OPEN SOURCE                              │
│  License, contributing, community standards         │
├─────────────────────────────────────────────────────┤
│  CAMADA 10: EVIDENCE                                │
│  Records, logs, reports, audit trail                │
└─────────────────────────────────────────────────────┘

Descrição de Cada Camada

Camada 1 — Corporate

Finalidade: Visão, missão, estrutura organizacional, estratégia. Documentos de longa duração, audiência interna e investidores.

Responsável: Founder
Atualização: Anual ou quando houver mudança estratégica relevante
Repositório: docs-company/company/


Camada 2 — Governance

Finalidade: Políticas (POL-*), processos (PROC-*), ADRs, código de conduta. Define como a empresa opera e toma decisões.

Responsável: Founder / Security / Dev Lead (por documento)
Atualização: Políticas: revisão anual mínima. ADRs: imutáveis.
Repositório: docs-company/policies/, docs-governance/


Camada 3 — Product

Finalidade: Service Master Records (service.yaml), SLA, SLO, roadmap de produto, suporte. Define compromissos com clientes.

Responsável: Product Owner / Ops
Atualização: Service Master Record: a cada mudança relevante. SLA: revisão com clientes.
Repositório: api-{nome}/service.yaml, api-{nome}/docs/sla.md


Camada 4 — API

Finalidade: OpenAPI spec, README, getting started, autenticação, erros, rate limits, versionamento, changelog. Audiência: developers externos.

Responsável: Developer / Dev Lead
Atualização: OpenAPI e CHANGELOG: a cada release. Outros: conforme mudanças.
Repositório: api-{nome}/


Camada 5 — Data

Finalidade: Source records, dataset records, field documentation, provenance, lineage, quality. Especialmente crítica para APIs de dados.

Responsável: Data Engineer
Atualização: Source Records: quando a fonte mudar. Dataset Records: a cada versão. Quality Reports: periodicamente.
Repositório: data-{nome}/


Camada 6 — Service Management

Finalidade: Incidentes, mudanças, releases, continuidade de negócio. Registros operacionais do dia-a-dia.

Responsável: Ops / Dev
Atualização: Templates: quando o processo mudar. Logs/Records: a cada evento.
Repositório: docs-company/processes/


Camada 7 — Security

Finalidade: Política de segurança, controle de acesso, gestão de segredos, vulnerabilidades, monitoramento. Base para futura estrutura ISO/IEC 27001.

Responsável: Security / Founder
Atualização: Política: revisão anual. Vulnerability reports: contínuo.
Repositório: docs-company/policies/


Finalidade: LGPD, termos de serviço, política de privacidade, licenças de dados, uso aceitável. Requer revisão jurídica.

Responsável: Legal / Founder
Atualização: Quando houver mudança regulatória ou de negócio.
Repositório: docs-company/legal/

LEGAL REVIEW REQUIRED

Todos os documentos desta camada. A LGPD (Lei nº 13.709/2018) pode ser aplicável desde o momento em que a empresa coleta ou processa dados de pessoas físicas — inclusive no MVP. Consultar advogado especializado antes de publicar qualquer serviço que envolva dados pessoais.


Camada 9 — Open Source

Finalidade: LICENSE, CONTRIBUTING, CODE_OF_CONDUCT, GOVERNANCE, ROADMAP. Audiência: comunidade de developers externos.

Responsável: Founder / Dev Lead
Atualização: Conforme necessidade da comunidade.
Repositório: docs-governance/, raiz de api-{nome}/


Camada 10 — Evidence

Finalidade: Records de incidentes, mudanças, releases, testes de backup, scans de segurança. Prova que os processos foram seguidos.

Responsável: Ops / Dev (quem executou o processo)
Atualização: A cada evento documentado.
Repositório: GitHub Issues (registros), GitHub Releases (releases), arquivos de log em docs-company/


Distinção Fundamental: Document vs Record vs Evidence

Por que isso importa para auditorias

Conceito Definição Exemplo
Document Instrução, política, processo, template — como fazer POL-SEC-001-security-policy.md
Record Evidência de que algo aconteceu — o que foi feito, quando, por quem INC-2026-0001.md
Evidence Conjunto de records que comprova conformidade sistemática Todos os INC-* do último ano

O auditor não quer apenas a política (document). Quer ver que ela foi seguida (record). E quer poder verificar que o conjunto de records demonstra conformidade sistemática (evidence).


Próximo passo

Consulte o Inventário por Camada para ver a lista completa de documentos com stage de criação, responsável e referência ISO.