Come usare questa guida¶
Questa pagina serve come punto di orientamento. La knowledge base non va letta tutta in ordine: va usata in base al problema da risolvere.
In questa pagina impari¶
- dove iniziare se non conosci ancora la struttura;
- quale pagina aprire in base al problema;
- quando usare pagina generale, playbook, known issue o standard;
- come evitare duplicazioni quando aggiungi nuova documentazione.
Non so da dove partire¶
Questo flusso serve per scegliere rapidamente la prima pagina utile.
flowchart TD
A[Obiettivo o problema]:::info --> B{Problema pratico?}:::warn
B -->|Sì| C[Troubleshooting]:::process
C --> D{Procedura guidata?}:::warn
D -->|Sì| E[Playbook]:::process
D -->|No| F[Known issue o caso]:::todo
B -->|No| G{Regola o convenzione?}:::warn
G -->|Sì| H[Standard o decision log]:::ok
G -->|No| I[Overview e concetti]:::info
classDef ok fill:#e6f4ea,stroke:#2e7d32,color:#1b5e20;
classDef warn fill:#fff4e5,stroke:#ef6c00,color:#5d4037;
classDef info fill:#e8f0fe,stroke:#1565c0,color:#0d47a1;
classDef todo fill:#f3e8ff,stroke:#7b1fa2,color:#4a148c;
classDef process fill:#f5f5f5,stroke:#757575,color:#212121;
Percorsi consigliati¶
| Se devi... | Parti da | Poi vai a |
|---|---|---|
| capire come è organizzata la guida | Overview | Concetti SPAC |
| preparare ambiente o progetto | Libreria custom | Template progetto |
| lavorare su uno schema unifilare | Schema unifilare | Numerazione e identificazione fili |
| lavorare su uno schema multifilare | Multifilare | Rimandi e morsetti |
| creare o sistemare un simbolo custom | Simboli custom | Attributi e pinatura |
| verificare un simbolo prima del riuso | Checklist validazione simbolo | Quality gates |
| gestire materiali o cavi | Archivi materiali custom | Archivio Cavi DbCables |
| scaricare archivi pubblicati | Download | Back-check e controlli incrociati |
| seguire una procedura passo-passo | Playbook | Command Reference |
| risolvere un problema pratico | Troubleshooting | Known Issues |
| capire una scelta già presa | Decision log | Standard operativi |
Scelta rapida¶
| Caso | Prima pagina utile | Supporto operativo |
|---|---|---|
| Un morsetto mostra numero filo, numero morsetto o morsettiera non attesi | Rimandi e morsetti | Verificare rappresentazione morsetti |
| Un rimando non accetta la linea o punta a una vecchia posizione | Rimandi e morsetti | Diagnosticare rimandi alimentazione |
| Un accessorio o una bobina non risulta collegato al componente | Multifilare | Gestire accessori e bobine |
| Un materiale manca o risulta duplicato in distinta | Archivi materiali custom | Associare materiali |
| SPAC segnala versione librerie non allineata per DbCables | Archivio Cavi DbCables | Known Issue DbCables |
| Devi pubblicare o verificare un file scaricabile | Download | Quality gates |
Regola pratica¶
Ogni pagina dovrebbe aiutare a fare almeno una di queste cose:
- decidere;
- configurare;
- verificare;
- diagnosticare;
- standardizzare.
Se una pagina non aiuta in nessuno di questi punti, va semplificata.
Uso corretto
Una pagina generale orienta. Un playbook guida una procedura. Una known issue diagnostica un problema ricorrente. Un quality gate decide se il lavoro è pronto.
Differenza tra sezioni¶
| Sezione | Scopo |
|---|---|
| Start | Orientamento, guida completa, concetti e glossario |
| Operativo | Setup, schemi, simboli, archivi e download |
| Playbook | Procedure guidate, checklist e riferimenti rapidi |
| Diagnosi | Problemi noti, troubleshooting e casi pratici |
| Governance | Standard, decisioni, manutenzione, quality gates e roadmap |
Metodo di aggiornamento¶
Quando si aggiunge una nuova informazione:
- inserirla nella sezione corretta;
- collegarla a una procedura o a uno standard;
- evitare duplicazioni;
- aggiungere uno schema solo se chiarisce davvero il funzionamento;
- verificare che la pagina sia raggiungibile dalla navigazione o dalla Home.