Português (Brasil): README.pt_BR.md
Data Boar is not shelfware; it is a precision instrument for forensic auditing. Every code path follows flight-engineering rigor. If documentation does not reflect code, documentation is a bug.
This folder centralizes application documentation. Navigation hubs (start here for agents): hubs/INDEX.md (pt-BR). Repository root keeps the files that GitHub and tooling expect (e.g. README.md, SECURITY.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, LICENSE). Use this index to find guides in English and Português (Brasil) and to jump between languages. Browse the tables below by topic; each row links to the English and Português (Brasil) version when available, so you can reach every document and switch language at any time. Partners / investors landing from GitHub: the root README section The Architect's Vault (README.md) surfaces the decision-maker value brief, ADR index, narrative history placeholder, governance-of-the-auditor ADR, and this index in one table—without linking execution plans from the pitch surface (ADR 0004). Concern-first navigation (CISO / DPO: minors, jurisdiction hints, child-privacy samples): MAP.md (pt-BR).
- Operator-only / homelab facts: Real hostnames, LAN IPs, and inventory belong in gitignored
docs/private/homelab/, not in tracked Markdown. Policy: PRIVATE_OPERATOR_NOTES.md (pt-BR). Tracked template to copy: private.example/. - Location: Application documentation (user-facing guides, reference, branding, plans, releases) lives under docs/. The repo root keeps only what GitHub and automation expect: README, SECURITY, CONTRIBUTING, CODE_OF_CONDUCT, LICENSE, NOTICE, TERMS_OF_USE, PRIVACY_POLICY. Do not move those. Module-level READMEs that are mere pointers (e.g. deploy/README.md, tests/README.md) or deprecated notices next to code (e.g. database/, scanners/) may stay beside the code. .github/ and .cursor/ stay where GitHub and Cursor expect them. New substantive docs (e.g. mascot, logo candidates, feature guides) belong in docs/ and should be linked from this index. Operator runbooks (Git workflow, home-lab validation, self-hosted SonarQube, notification channels, Docker deploy troubleshooting) live under ops/ in English and pt-BR; primary user-facing guides (USAGE, TESTING, DOCKER_SETUP) stay at docs/ root so app-user discoverability is unchanged.
- English (EN) is the canonical source: it represents the true capabilities, features, arguments, config, and behaviour of the application. When behaviour or options change, update the English doc first.
- Brazilian Portuguese (pt-BR) must be kept in sync with the English version. Each pt-BR file is a translation of its English counterpart (same structure and coverage).
- New documentation: Any new documentation file (user-facing guides, reference, legal/copyright, deploy, testing, etc.) must exist in both English and Brazilian Portuguese. Exception: plan files (e.g. under
docs/plans/,docs/plans/completed/, or.cursor/plans/) and numbered ADR bodies (docs/adr/ADR-0000-*.md,ADR-0001-*.md, …) may be English-only (canonical decision text); the adr/README.md index has a pt-BR companion. When a plan or ADR drives application changes, update the other docs (README, USAGE, etc.) in both languages when they are user-facing. - When you update docs to reflect application changes, sync the other language too: edit the EN doc first, then update the corresponding pt-BR file so structure and coverage stay aligned.
- Language switcher: Every documentation file that has a translation must have at the top (right after the title or in the first line) a clear link to the other language, e.g.
- In EN files:
**Português (Brasil):** [Filename.pt_BR.md](Filename.pt_BR.md) - In pt-BR files:
**English:** [Filename.md](Filename.md) - Discoverability: When a doc mentions a topic that has its own dedicated doc (e.g. deploy, Docker, Kubernetes, testing, topology, commit/PR, compliance), it should link to that doc; if that doc exists in both languages, provide both links (e.g.
[DEPLOY.md](deploy/DEPLOY.md) ([pt-BR](deploy/DEPLOY.pt_BR.md))) so the user can switch language easily. The main index is this README. - Planning vs product docs: Do not add Markdown links from buyer/legal/compliance/product guides into
docs/plans/or.cursor/plans/. Use this index Internal and reference (below) as the deliberate entry point to PMO files; operator runbooks underdocs/ops/may still link to plans. CI guard:tests/test_docs_external_no_plan_links.py. Rule:.cursor/rules/audience-segmentation-docs.mdc.
These stay at repo root for GitHub and automation:
| Document | English | Português (pt-BR) |
|---|---|---|
| Readme | README.md | README.pt_BR.md |
| License | LICENSE | LICENSE.pt_BR.md |
| Notice (copyright) | NOTICE | NOTICE.pt_BR.md |
| Terms of use | TERMS_OF_USE.md | TERMS_OF_USE.pt_BR.md |
| Privacy policy | PRIVACY_POLICY.md | PRIVACY_POLICY.pt_BR.md |
| Security | SECURITY.md | SECURITY.pt_BR.md |
| Contributing | CONTRIBUTING.md | CONTRIBUTING.pt_BR.md |
| Code of conduct | CODE_OF_CONDUCT.md | CODE_OF_CONDUCT.pt_BR.md |
| Quick start (5 min) | QUICKSTART.md | QUICKSTART.pt_BR.md |
| Topic | English | Português (pt-BR) |
|---|---|---|
| Quick start (5 min — first contact) | QUICKSTART.md | QUICKSTART.pt_BR.md |
| Technical guide (install, run, CLI/API, connectors) | TECH_GUIDE.md | TECH_GUIDE.pt_BR.md |
| Enterprise integration (IT / SRE — deploy, CI, security; not pricing) | ENTERPRISE_INTEGRATION_GUIDE.md | ENTERPRISE_INTEGRATION_GUIDE.pt_BR.md |
| Topic map (minors, jurisdiction hints, child-privacy samples — by concern) | MAP.md | MAP.pt_BR.md |
| Usage (CLI, API) | USAGE.md | USAGE.pt_BR.md |
Config samples hub (links to deploy/samples, legacy JSON note) |
samples/README.md | samples/README.pt_BR.md |
| Sensitivity (ML/DL) | SENSITIVITY_DETECTION.md | SENSITIVITY_DETECTION.pt_BR.md |
| Minor detection | MINOR_DETECTION.md | MINOR_DETECTION.pt_BR.md |
| Security (fixes, tests, technician guidance; operator hardening / Priority band A) | SECURITY.md · CODE_PROTECTION_OPERATOR_PLAYBOOK.md | SECURITY.pt_BR.md · CODE_PROTECTION_OPERATOR_PLAYBOOK.pt_BR.md |
| Versioning | VERSIONING.md | VERSIONING.pt_BR.md |
| Adding connectors | ADDING_CONNECTORS.md | ADDING_CONNECTORS.pt_BR.md |
| Plugin author guide (YAML pattern plugins — regex / ML / DL) | PLUGIN_AUTHOR_GUIDE.md | PLUGIN_AUTHOR_GUIDE.pt_BR.md |
| Plugin SDK (Enterprise remediation L1 — partner guide) | PLUGIN_SDK.md | PLUGIN_SDK.pt_BR.md |
| Plugin SDK contract (language-neutral L1/L2/L3 — #865) | SDK.md · sdk/PLUGIN_CONTRACT.schema.json | — (EN hub; L1 how-to remains in PLUGIN_SDK.pt_BR) |
| Compliance | COMPLIANCE_FRAMEWORKS.md | COMPLIANCE_FRAMEWORKS.pt_BR.md |
| ITSM / IT governance alignment (ITIL 4, COBIT, ISO 38500 / 27014 / 20000) | ITSM_GOVERNANCE_ALIGNMENT.md | ITSM_GOVERNANCE_ALIGNMENT.pt_BR.md |
| Audience guide (entry points by role — overlaps, what to skip) | AUDIENCE_GUIDE.md | AUDIENCE_GUIDE.pt_BR.md |
| Decision-maker value brief (leadership/legal/compliance) | DECISION_MAKER_VALUE_BRIEF.md | DECISION_MAKER_VALUE_BRIEF.pt_BR.md |
| Compliance and legal (for legal teams and DPOs) | COMPLIANCE_AND_LEGAL.md | COMPLIANCE_AND_LEGAL.pt_BR.md |
| Compliance methodology (verification modules, ROPA-style column priorities) | COMPLIANCE_METHODOLOGY.md | COMPLIANCE_METHODOLOGY.pt_BR.md |
| Reports and compliance outputs (XLSX, heatmap, audit JSON, maturity export; PDF roadmap) | REPORTS_AND_COMPLIANCE_OUTPUTS.md | REPORTS_AND_COMPLIANCE_OUTPUTS.pt_BR.md |
| GRC executive JSON (risk matrix contract for CISO/DPO dashboards and PDF engines) | GRC_EXECUTIVE_REPORT_SCHEMA.md | GRC_EXECUTIVE_REPORT_SCHEMA.pt_BR.md |
| Jurisdiction collision / multinational hints (DPO narrative — not legal advice) | JURISDICTION_COLLISION_HANDLING.md | JURISDICTION_COLLISION_HANDLING.pt_BR.md |
| Use-case storyboards (workshop flows) | use-cases/README.md (MSP, insurance, RPO, real estate, NGO, EdTech, port, law, accounting, pharma — mid-market) | use-cases/README.pt_BR.md |
| Executive pitch decks (stakeholder, DPO, DPO+legal, CISO, CDO, IT governance, PMO, CFO, CCO) | pitch/INDEX.md | pitch/INDEX.pt_BR.md |
| Product philosophy (evidence over theatre; public-safe) | philosophy/THE_WHY.md | philosophy/THE_WHY.pt_BR.md |
| Engineering practices (fail-closed, pin+cooldown, integrity, metadata-first) | ENGINEERING_PRACTICES.md | ENGINEERING_PRACTICES.pt_BR.md |
| LGPD witness report (ISP field visit — consumer awareness, Brazil 2026) | LGPD_WITNESS_REPORT_NIO_FIELD_VISIT_2026.md | LGPD_WITNESS_REPORT_NIO_FIELD_VISIT_2026.pt_BR.md |
| Compliance technical reference (IT, security — encodings, API limits, timeouts) | COMPLIANCE_TECHNICAL_REFERENCE.md | COMPLIANCE_TECHNICAL_REFERENCE.pt_BR.md |
| Compliance samples (UK GDPR, EU GDPR, PIPEDA, 152-FZ (Russia), etc.) | compliance-samples/ · COMPLIANCE_FRAMEWORKS.md#compliance-samples · compliance-samples/OPERATOR_GOVERNANCE_CHECKLIST.md | compliance-samples/ · COMPLIANCE_FRAMEWORKS.pt_BR.md#amostras-de-conformidade · compliance-samples/OPERATOR_GOVERNANCE_CHECKLIST.pt_BR.md |
| Operator / IT requirements (minimal permissions) | ops/OPERATOR_IT_REQUIREMENTS.md | ops/OPERATOR_IT_REQUIREMENTS.pt_BR.md |
| Glossary (terms by theme; A–Z within each section — ADR 0022) | GLOSSARY.md | GLOSSARY.pt_BR.md |
| AI evolution primer (winters, expert systems, ML/DL, LLMs — no hype, integrator context) | AI_EVOLUTION_PRIMER.md | AI_EVOLUTION_PRIMER.pt_BR.md |
| Forensics and evidence primer (inventory artefacts vs official forensic report) | FORENSICS_AND_EVIDENCE_PRIMER.md | FORENSICS_AND_EVIDENCE_PRIMER.pt_BR.md |
| Topic | English | Português (pt-BR) |
|---|---|---|
| Deploy guide | deploy/DEPLOY.md | deploy/DEPLOY.pt_BR.md |
| Docker setup (MCP, build, push) | DOCKER_SETUP.md | DOCKER_SETUP.pt_BR.md |
| Starter config samples (copy-paste YAML, CSV scope) | ../deploy/samples/README.md | ../deploy/samples/README.pt_BR.md |
Deploy assets (Compose, Kubernetes, config examples) remain in the deploy/ folder; see deploy/README.md for pointers to the deploy docs above. First-run config: ../deploy/samples/ (LGPD-oriented starter YAML and scope CSV example).
| Topic | English |
|---|---|
| Mascot assets | MASCOT.md |
| Logo candidates | LOGO_CANDIDATES.md |
| Social copy drafts (LinkedIn / X style; not CI-scheduled) | EN / pt-BR |
- ops/README.md — Operator runbooks index (this folder) and link-audit checklist for doc moves.
- plans/PLANS_TODO.md — Plan status and current app state (single source of truth for open-plan to-dos). Plan files are EN-only for history; operator runbooks under ops/ are EN + pt-BR.
- ops/PLANS_DOCUMENTATION_HIERARCHY.md —
PLAN_*.mdvsPLANS_HUBvsPLANS_TODO: three-layer PMO model and maintainer ritual — pt-BR. - plans/PLANS_HUB.md — Plans hub: table of every
PLAN_*.md(open + completed) for collaborators; refresh withpython scripts/plans_hub_sync.py --write. pt-BR intro. - plans/MAINTENANCE_FRONT_OF_WORK.md — After parallel PR bursts: keep one active dev front; CI/Python matrix alignment; optional maintenance slices (Scout, deps).
- plans/PYTHON_UPGRADE_PLAYBOOK.md — Python runtime upgrade sequencing (3.12→3.13→…), Docker, CI, and wheels; pt-BR companion.
- plans/SPRINTS_AND_MILESTONES.md — Token-aware sprints, milestones, Gantt/Kanban, SRE-aligned workflow (toil, SLO/error budget, blameless retro); pt-BR companion.
- External evolution reviews are mapped into plan history (internal; not a public doc surface).
- releases/ — Release notes (e.g. 1.7.3, 1.7.2+safe / v1.7.2-safe, 1.7.1, 1.7.0, 1.6.8, 1.6.7, 1.6.5, 1.6.4, 1.6.3, 1.6.2, 1.6.1, 1.6.0, 1.5.4, 1.5.3, 1.4.3).
- plans/completed/ — Archived completed plans and the implementation checklist (NEXT_STEPS.md), all items Done.
Man pages: docs/data_boar.1 (command), docs/data_boar.5 (config and file formats). Install and optionally add compatibility symlinks so man lgpd_crawler also works (see root README and TECH_GUIDE.md).