davideandClaude Opus 5
ea9f17e8d2
Il changelog aveva sezioni narrative sotto «Versione attuale», che non diceva quale versione, e una «Versione 1.0 — luglio 2026» data per rilasciata mentre il pacchetto è alla 0.9.0 ancora da distribuire. Ora la testa è `[Non rilasciato] — 0.9.0` in formato Keep a Changelog: essendo la prima versione tutto è Aggiunto, con la sola Sicurezza a parte — niente Modificato, Rimosso o Corretto, che presuppongono qualcosa già uscito. La roadmap perde i numeri di versione (1.0, 1.1, 1.2, 2.0) e diventa Fatto / Prossimo / Idee future: numerava per traguardo funzionale mentre il changelog numera i rilasci, e tenere allineate due numerazioni diverse per lo stesso progetto è lavoro che nessuno farà. Le versioni ora stanno solo nel changelog. Nessuna voce persa. Aggiornati i rimandi rimasti indietro: la regola di manutenzione e l'indice in docs/README.md, la citazione «CHANGELOG v1.0.6» e la nota su AI Allenamenti in DESIGN_DECISIONS.md, «la v1.1 è completa» in PROJECT_STATE.md. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2.9 KiB
Documentazione CrAPP
Indice della documentazione ufficiale del progetto. Ogni file risponde a una domanda precisa: se l'informazione che cerchi non è nel file indicato, probabilmente non esiste ancora e va prima documentata (vedi DD-002).
Dove sta cosa
| Documento | Risponde a |
|---|---|
| ROADMAP.md | Cosa è fatto, cosa è previsto, cosa resta un'idea |
| ARCHITECTURE.md | Com'è fatta l'app: stack, struttura del codice, flusso di sviluppo |
| DATABASE.md | Quali tabelle esistono, a cosa servono, chi le usa |
| DESIGN_DECISIONS.md | Perché abbiamo scelto così, cosa abbiamo escluso e quando riaprire la scelta |
| PORTABILITA.md | Cosa lega l'app a un fornitore e cosa no, come spostarla su server proprio |
| EFFICIENZA_CLOUD.md | Come tenere basso il consumo cloud: cache, query, push |
| CHANGELOG.md | Cosa è cambiato e quando |
| modules/ | Specifica funzionale di ogni modulo, una per file |
Le regole vincolanti per gli assistenti AI stanno in AGENTS.md; lo stato corrente del lavoro in PROJECT_STATE.md.
Ordine di lettura
Prima di modificare il codice, nell'ordine: questo indice → ROADMAP.md → ARCHITECTURE.md
→ DATABASE.md → DESIGN_DECISIONS.md → il documento del modulo interessato in modules/.
Regole di manutenzione
Ogni informazione ha una sola casa, per evitare che le copie divergano:
- l'elenco delle funzionalità (fatte e previste) sta solo in
ROADMAP.md; CHANGELOG.mdregistra quando qualcosa è stato rilasciato, non ripete l'elenco: segue il formato Keep a Changelog, con il lavoro non ancora rilasciato sotto[Non rilasciato]e le voci divise per categoria (Aggiunto, Modificato, Sicurezza…);- il lavoro in corso sta solo in
PROJECT_STATE.md, che rimanda alla roadmap per il resto; - lo schema del database sta solo in
DATABASE.md, allineato alle migration insupabase/migrations/: una tabella nuova si documenta nella stessa modifica che la crea; - le motivazioni stanno solo in
DESIGN_DECISIONS.md, in vociDD-XXX; per aggiungerne una si copia _template-dd.md.
Convenzioni di scrittura: un solo titolo # per file (le sezioni interne partono da ##),
niente --- come riempitivo tra i paragrafi, tabelle al posto degli elenchi ripetitivi.