37 lines
2.3 KiB
Markdown
37 lines
2.3 KiB
Markdown
 
|
# Documentazione
|
||
|
|
|
||
|
|
Indice e regole. Ogni informazione vive in **un solo documento**; gli altri la richiamano con un link.
|
||
|
|
|
||
|
|
| Documento | Contenuto (sorgente di verità per…) |
|
||
|
|
|---|---|
|
||
|
|
| [../README.md](../README.md) | Uso, requisiti, build e publish |
|
||
|
|
| [MVP.md](MVP.md) | Specifica funzionale, design UI/UX, criteri di accettazione |
|
||
|
|
| [ROADMAP.md](ROADMAP.md) | Fasi e stato (spunte); solo passi, mai motivazioni |
|
||
|
|
| `adr/NNNN-*.md` | Decisioni architetturali e loro motivazioni (indice sotto) |
|
||
|
|
| [../CLAUDE.md](../CLAUDE.md) | Guida per Claude Code: comandi, architettura del codice, vincoli |
|
||
|
|
|
||
|
|
## Nome del progetto
|
||
|
|
Il nome è **provvisorio** (oggi `LlmRun`) e non è ancora deciso. Questa sezione è l'unica sorgente: gli altri doc scrivono "l'app" o `<nome-app>`.
|
||
|
|
|
||
|
|
Se il nome cambia, aggiornare solo questi punti:
|
||
|
|
- [ ] `AssemblyName`/nome del csproj e dell'eseguibile (`<nome-app>.exe`, `<nome-app>`)
|
||
|
|
- [ ] Costante del nome nel codice (titolo finestra, intestazione della barra laterale, cartella dati)
|
||
|
|
- [ ] **Cartella dati** `<LocalApplicationData>/<nome-app>/chats`: cambiando nome le chat salvate non si trovano più; migrare o leggere anche la vecchia cartella
|
||
|
|
- [ ] Titolo di [../README.md](../README.md) e riga iniziale di [../CLAUDE.md](../CLAUDE.md) (nome del csproj nei comandi)
|
||
|
|
|
||
|
|
## Flusso (doc-first, doc-as-code)
|
||
|
|
1. Prima i doc, poi il codice: ADR (se c'è una scelta architetturale) → MVP → ROADMAP → README → codice → CLAUDE.md.
|
||
|
|
2. I doc stanno nel repo e cambiano con lo stesso commit del codice a cui si riferiscono.
|
||
|
|
3. Una modifica non deve lasciare i doc disallineati.
|
||
|
|
|
||
|
|
## Regole degli ADR
|
||
|
|
- Un file per decisione, `adr/NNNN-titolo-breve.md`, numerazione progressiva.
|
||
|
|
- Stati: `Proposta` → `Accettata` → eventualmente `Sostituita da ADR-NNNN` o `Rifiutata`.
|
||
|
|
- Un ADR accettato non si riscrive: se la decisione cambia se ne scrive uno nuovo che lo sostituisce e si aggiorna lo stato del vecchio.
|
||
|
|
- Sezioni: Contesto, Criteri, Opzioni, Decisione, Conseguenze, Da verificare, Riferimenti.
|
||
|
|
|
||
|
|
## Indice ADR
|
||
|
|
| ADR | Titolo | Stato |
|
||
|
|
|---|---|---|
|
||
|
|
| [0001](adr/0001-gui-multipiattaforma-avalonia.md) | GUI multipiattaforma in solo C# con Avalonia | Proposta |
|
||
|
|
| [0002](adr/0002-motori-cli-claude-codex-antigravity.md) | Più motori CLI (Claude Code, Codex, Antigravity) su Windows e Linux | Proposta |
|