# START ## Scopo Il presente documento descrive come consultare la documentazione tecnica B-Arts. La prima lettura, sia per gli sviluppatori sia per gli assistenti basati su Intelligenza Artificiale, deve essere [ECOSYSTEM.md](ECOSYSTEM.md), che presenta la struttura generale dell'ecosistema e permette di individuare il framework, il modello o la linea tecnologica pertinente. Ha lo scopo di descrivere come è organizzata la documentazione, come consultarla e quali convenzioni seguire durante lo sviluppo o l'utilizzo dell'ecosistema. La documentazione è stata progettata per essere facilmente consultabile sia dagli sviluppatori sia dagli assistenti basati su Intelligenza Artificiale. --- ## Obiettivi La documentazione di B-Arts ha i seguenti obiettivi: - Descrivere il funzionamento dell'ecosistema B-Arts. - Definire le convenzioni di sviluppo. - Documentare in modo completo API, controlli, componenti e strumenti. - Fornire esempi di utilizzo. - Costituire la fonte ufficiale della documentazione tecnica del progetto. - Documentare la storia e l'evoluzione del progetto. --- ## Destinatari La documentazione è rivolta a: - Sviluppatori. - Team di sviluppo. - Manutentori dell'ecosistema. - Assistenti basati su Intelligenza Artificiale. --- ## Organizzazione della documentazione La documentazione è suddivisa in documenti indipendenti. Ogni documento descrive un singolo argomento. La documentazione evita duplicazioni di contenuto e utilizza riferimenti agli altri documenti quando necessario. Ogni documento può essere consultato indipendentemente dagli altri, salvo diversa indicazione. --- ## Regole di consultazione Durante la consultazione della documentazione devono essere rispettate le seguenti regole: - Considerare questa documentazione come riferimento ufficiale dell'ecosistema B-Arts. - Non assumere comportamenti non documentati. - In caso di informazioni mancanti, considerare il comportamento non definito. - Consultare sempre il documento specifico relativo alla classe, al componente o allo strumento interessato. --- ## Convenzioni La documentazione utilizza le seguenti convenzioni: - Un documento descrive un singolo argomento. - Il nome dei documenti dedicati alle classi coincide con il nome della classe. - I documenti generali sono identificati con nomi descrittivi in maiuscolo. - Gli esempi presenti nella documentazione rappresentano il comportamento corretto dell'ecosistema. --- ## Percorso consigliato Per una prima consultazione si consiglia il seguente ordine: 1. [Ecosistema B-Arts](ECOSYSTEM.md): comprendere la struttura generale e identificare il tipo di progetto. 2. [Regole e convenzioni](RULES.md): applicare il modo di lavorare B-Arts. 3. [Principi di progettazione](DESIGN.md): comprendere le scelte architetturali. 4. [Istruzioni per gli assistenti AI](ASSISTANTS.md), quando la documentazione viene consultata da un assistente. 5. [BFramework](BFramework.md), [Controlli Web](BFrameworkWebControls.md) o [Controlli Windows](BFrameworkControls.md), secondo il componente utilizzato. 6. [Modelli di progetto](MODELS.md), quando si deve creare o comprendere la struttura di un progetto. 7. [Linea .NET classica](CLASSIC.md), quando il progetto utilizza `BNetFramework`, `BStandardFramework` o ASP.NET Web Forms. 8. [Framework legacy](LEGACY.md), soltanto quando il progetto referenzia esplicitamente un pacchetto deprecato. 9. Documentazione della classe interessata, relativi esempi, FAQ e casi d'uso. --- ## Documentazione correlata La documentazione è composta da più documenti tra loro collegati. Ogni documento contiene esclusivamente le informazioni relative all'argomento trattato. La documentazione deve essere mantenuta coerente con il codice sorgente. In caso di discrepanza tra documentazione e codice, il codice sorgente rappresenta il comportamento effettivo dell'ecosistema fino all'aggiornamento della documentazione.