Skip to content

📚 Revisione completa documentazione in /docs #68

@artcava

Description

@artcava

🎯 Obiettivo

Rivedere e aggiornare tutta la documentazione presente nella cartella /docs per assicurare:

  • Accuratezza rispetto all'implementazione corrente
  • Coerenza tra i vari documenti
  • Completezza delle informazioni
  • Rimozione di informazioni obsolete o ridondanti

📄 Documenti da Rivedere

Priorità Alta

  1. ARCHITECTURE.md - Verificare pattern MVVM, offline-first, struttura attuale
  2. DATABASE.md - Schema SQLite, ER diagram, crittografia, query
  3. SYNC-PROTOCOL.md - Algoritmo sincronizzazione, conflict resolution
  4. SECURITY.md - Crittografia, HMAC, key management

Priorità Media

  1. SETUP-GUIDE.md - Setup Visual Studio, path corretti
  2. SEED.md - Strategia data initialization, DbContextSeeder
  3. DEVELOPMENT.md - Guida sviluppatori, Git workflow
  4. DEPLOYMENT.md - Velopack, distribution, updates

Priorità Bassa

  1. API.md - Services API documentation
  2. WORKFLOW.md - Workflow applicativo
  3. PROGETTO_PTRP_SYNC.md - Analisi tecnica completa

✅ Checklist per Ogni Documento

Per ciascun documento verificare:

  • Nomi di progetti/file/path corrispondono alla struttura reale
  • Esempi di codice sono aggiornati e funzionanti
  • Diagrammi (se presenti) riflettono l'implementazione attuale
  • Riferimenti incrociati tra documenti sono corretti
  • Non ci sono informazioni duplicate tra documenti
  • Linguaggio chiaro e coerente
  • Esempi pratici dove appropriato

📖 Azioni Specifiche

1. Verifica Path e Naming

  • Controllare che tutti i riferimenti a progetti (PTRP.App, PTRP.Data, etc.) siano corretti
  • Verificare path di file e cartelle
  • Aggiornare comandi CLI con path corretti

2. Aggiornamento Struttura

  • Riflettere l'attuale organizzazione:
    • PTRP.Models - Modelli di dominio
    • PTRP.Data - Data access, DbContext, repositories
    • PTRP.Services - Business logic services
    • PTRP.ViewModels - ViewModels MVVM
    • PTRP.App - WPF Application

3. Sincronizzazione Contenuti

  • Assicurare che concetti spiegati in ARCHITECTURE.md siano coerenti con SYNC-PROTOCOL.md
  • Verificare che SECURITY.md sia allineato con l'implementazione in PTRP.Data
  • Controllare che SEED.md descriva l'effettivo DbContextSeeder

4. Rimozione Ridondanze

  • Identificare informazioni duplicate tra documenti
  • Centralizzare concetti in un unico documento con riferimenti incrociati
  • Eliminare sezioni obsolete

📅 Timeline

Non urgente - Da programmare quando:

  • Completate le funzionalità core dell'applicazione
  • Stabilizzata l'architettura
  • Prima di eventuali release pubbliche

📝 Note

  • Questa revisione è un promemoria per il futuro
  • Non blocca lo sviluppo corrente
  • Può essere affrontata documento per documento in modo incrementale
  • Considerare di creare sotto-issue per ogni documento se la revisione diventa troppo estesa

Creata il: 31 Gennaio 2026
Riferimento: Conversazione post-aggiornamento README

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions