Passa al contenuto principale

Documentazione di Playroll

Playroll Docs è la fonte di verità duratura su come il prodotto registra le sessioni di gioco, valida le sessioni, carica gli artefatti, espone i dati di monitoraggio e aiuta i tester a risolvere le segnalazioni dei giocatori.

Questo sito deve crescere insieme alla codebase. L'obiettivo non è rispecchiare ogni file sorgente. L'obiettivo è documentare i contratti e il comportamento operativo su cui le persone fanno affidamento.

Focus attuale​

  • Ciclo di vita della sessione di registrazione tra core, UI, SQLite locale, Supabase e infrastruttura di upload.
  • Comportamento della pipeline di cattura pure-v2 e monitoraggio della qualità degli FPS.
  • Regole di validazione pre-upload per MP4, CSV e metadati JSON.
  • Onboarding del portale dei contributor, prontezza per i pagamenti e collegamento dell'identità all'app Playroll.
  • Flussi di risoluzione problemi per i tester relativi alle sessioni dei giocatori e ai file caricati.
  • Eventi di telemetria usati per fare debug dei fallimenti di registrazione e delle regressioni di performance.

Repository​

  • playroll-cpp: registratore core, cattura pure-v2, validazione, metadati locali, comportamento di upload.
  • playroll-ui: UI desktop, cronologia delle sessioni, flusso di aggiornamento, stato visibile all'utente.
  • playroll-contributor-portal: onboarding dei contributor, accettazione documenti, metodo di ricezione dei pagamenti, bridge dell'identità dell'app.
  • playroll-infra: target di ownership dell'infrastruttura per Terraform e risorse cloud.
  • playroll-docs: questo sito di documentazione.

Cosa appartiene a questo sito​

Usa questo sito di documentazione per conoscenze stabili o semi-stabili:

  • Diagrammi di architettura e di ciclo di vita.
  • Runbook per tester e operatori.
  • Contratti delle view del database.
  • Catalogo degli eventi di telemetria.
  • Processo di rilascio e note sui rollout.
  • Architecture Decision Record.

Evita di usare questo sito come blocco per appunti. Le bozze possono vivere nei ticket o nelle PR; una volta che una decisione diventa operativamente rilevante, sposta qui la versione finale.