OPORA Dokumentace

Centrum nápovědy

Cíle

  • Poskytnout sdílený zdroj pravdy pro produktový záměr, architektonické invarianty a provozní zásady.
  • Umožnit škálovatelný vývoj jasným popisem hranic (doména vs. aplikační vrstva vs. infrastruktura).
  • Podpořit due diligence (bezpečnost, multi-tenancy, nasazování, rozhodnutí) bez marketingové omáčky.

Jak je dokumentace organizovaná

  • 00-product/: Produktový záměr a omezení (vize, ICP, pricing a gating).
  • 00-product/ux-success-metrics.md: Operativní UX a produktové KPI navázané na hlavní workflow.
  • 01-architecture/: Systémový návrh, invarianty, vrstvy a model multi-tenancy.
  • 01-architecture/project-editor-design-standard.md: Kanonický detailní UI/UX standard podle současné stránky /app/projects/[projectId]/edit; barevná sémantika, plochy, copy, sekce, workflow dock, motion, responsive a QA.
  • 01-architecture/design-system-governance.md: Governance pravidla pro komponentové stavy, status semantics a konzistenci UI.
  • 01-architecture/dashboard-and-projects-design-update.md: Interní přehled posledních designových změn v dashboardu, Projects flow a results surface.
  • design/: UI/UX designové podklady (pouze dokumentační reference; HTML se do aplikace nekopíruje).
  • 02-domain/: Doménové koncepty a deterministický výpočetní engine (co musí zůstat čisté a stabilní).
  • 03-application/: Aplikační kontrakty (API vzory, guard logika, stav a workflow).
  • 03-application/event-tracking-plan.md: Kanonický tracking plán pro produktové a UX eventy.
  • 03-application/projects-acceptance-criteria.md: Acceptance kritéria pro Projects flow a release review.
  • 03-application/projects-ux-implementation-backlog.md: Implementační backlog pro dashboard a Projects workflow.
  • 03-application/projects-ux-multi-agent-delivery-plan.md: Rozdělení backlogu na paralelní workstreamy pro více AI agentů.
  • 03-application/projects-ux-agent-prompt-packets.md: Hotové copy-paste prompty pro AG-00 až AG-07.
  • 03-application/issue-remediation-contract.md: Standard pro Opravit v editoru, editorTarget a remediation flow.
  • 03-application/stale-results-and-recalculation-policy.md: Politika stale výsledků a přepočtu.
  • 03-application/form-validation-and-error-copy-standard.md: Jednotná pravidla pro validace a chybové texty.
  • 03-application/autosave-and-unsaved-changes-policy.md: Standard pro autosave, dirty state a opuštění editoru.
  • 03-application/project-versioning-and-history-standard.md: Standard historie verzí, compare a restore.
  • 03-application/gating-messaging-standard.md: Jednotná pravidla pro RBAC a subscription messaging.
  • 03-application/team-invitations-and-seat-management.md: Kanonický model týmových míst, pozvánek, explicitního přijetí a produkčního rollout checklistu.
  • 03-application/first-customer-onboarding.md: Kanonická cesta registrace → organizace → první projekt včetně implementovaných kroků a budoucích produkčních gate.
  • 04-security/: Auth model, RBAC a threat model (co chráníme, jak a proč).
  • 05-devops/: Nasazování, prostředí, migrace a rollback přístup.
  • 05-devops/release-quality-gates.md: Quality gates a sign-off model pro releasy kritických workflow.
  • 06-testing/: Testovací filozofie a ověřování deterministických výpočtů.
  • 07-decisions/: ADR (Architectural Decision Records) pro nevratná nebo vysoce dopadová rozhodnutí.
  • documentation-maturity-standard.md: Doplňkový standard zralosti dokumentace a mapa toho, co ještě chybí do enterprise úrovně.

Doporučené čtecí cesty

  • První firemní pilot: [průchod zakázkou a měření přínosu](00-product/pilot-first-company.md) — konkrétní úkoly, předpoklady, záznam pomoci a podmínky přijetí; scénář zatím nebyl proveden firmou.
  • Co je hotové a co dál: [sjednocený seznam dokončení](00-product/completion-status.md) — doložené lokální výsledky, otevřené release kroky, hranice a návaznost na starší reporty.
  • Nový vývojář: 01-architecture/system-overview.md → 01-architecture/architecture-layers.md → ui-flow.md → 03-application/guard-logic.md → 02-domain/domain-model.md
  • Bezpečnostní review: 04-security/auth-model.md → 04-security/rbac-model.md → 04-security/threat-model.md → 01-architecture/multi-tenancy.md
  • Investor / diligence: 00-product/product-vision.md → 00-product/pricing-model.md → 01-architecture/system-overview.md → 05-devops/deployment.md → 07-decisions/
  • UI reference: 01-architecture/project-editor-design-standard.md → 01-architecture/design-system-governance.md → ui-flow.md → 01-architecture/ui-ux-design-reference.md
  • Aktuální designové změny: 01-architecture/dashboard-and-projects-design-update.md → 01-architecture/design-system-governance.md → 03-application/projects-ui-flow.md
  • Produkt / governance review: documentation-maturity-standard.md → 00-product/product-vision.md → 03-application/projects-ui-flow.md → 04-security/rbac-model.md
  • Produktové měření a delivery review: 00-product/ux-success-metrics.md → 03-application/event-tracking-plan.md → 03-application/projects-acceptance-criteria.md
  • Projects UX implementation review: 03-application/issue-remediation-contract.md → 03-application/stale-results-and-recalculation-policy.md → 03-application/form-validation-and-error-copy-standard.md → 03-application/autosave-and-unsaved-changes-policy.md
  • Projects UX delivery planning: 03-application/projects-ux-implementation-backlog.md → 03-application/projects-acceptance-criteria.md → 05-devops/release-quality-gates.md
  • Projects UX multi-agent execution: 03-application/projects-ux-multi-agent-delivery-plan.md → 03-application/projects-ux-implementation-backlog.md → 03-application/projects-acceptance-criteria.md
  • Projects UX agent kickoff: 03-application/projects-ux-agent-prompt-packets.md → 03-application/projects-ux-multi-agent-delivery-plan.md → 03-application/projects-ux-implementation-backlog.md
  • Release review: 05-devops/release-quality-gates.md → 06-testing/testing-strategy.md → 03-application/projects-acceptance-criteria.md
  • Týmové pozvánky a kapacita: 03-application/team-invitations-and-seat-management.md → 04-security/rbac-model.md → 00-product/pricing-model.md → 05-devops/release-quality-gates.md
  • Onboarding prvního zákazníka: 03-application/first-customer-onboarding.md → 03-application/projects-ui-flow.md → 04-security/auth-model.md → 05-devops/release-quality-gates.md

Standardy dokumentace

  • Psané v profesionální technické angličtině pro docs/en a v profesionální technické češtině pro docs/cs.
  • Priorita jsou invarianty a kontrakty; implementační detaily jen pokud jsou nutné k definici hranice.
  • Pokud si nejsme jistí, zapiš rozhodnutí jako ADR do 07-decisions/.