Linee guida di manutenzione¶
Questa sezione definisce come mantenere ordinata la knowledge base nel tempo.
Quando aggiungere una nuova nota¶
Aggiungere una nuova nota quando:
- il problema si è presentato più di una volta;
- la procedura è stata testata;
- la soluzione può essere utile in futuro;
- il contenuto non è specifico di una singola commessa;
- la nota riduce ambiguità operative.
Quando non aggiungere una nota¶
Evitare di aggiungere contenuti quando:
- sono appunti temporanei non verificati;
- contengono dati sensibili;
- riguardano solo un caso isolato senza valore riutilizzabile;
- duplicano contenuti già presenti;
- non indicano una procedura o una decisione.
Come scrivere una procedura¶
Una procedura deve essere:
- breve;
- sequenziale;
- verificabile;
- priva di ambiguità;
- collegata a eventuali checklist.
Struttura consigliata:
- contesto;
- problema o obiettivo;
- procedura;
- verifica finale;
- note operative.
Come aggiornare una decisione¶
Se una decisione cambia:
- non cancellare subito la decisione precedente;
- marcarla come superata o deprecata;
- aggiungere la nuova decisione;
- spiegare il motivo del cambiamento;
- aggiornare eventuali documenti collegati.
Revisione periodica¶
Ogni revisione dovrebbe controllare:
- link interni;
- contenuti duplicati;
- procedure incomplete;
- note non verificate;
- roadmap;
- changelog.
Regola principale¶
La knowledge base deve restare utile durante il lavoro reale. Se un contenuto non aiuta a decidere, risolvere o standardizzare, va semplificato o rimosso.