Una procedura sembra chiara a chi la svolge ogni giorno, perché molti passaggi restano nella memoria. Il test utile è diverso: una persona autorizzata che non l'ha scritta riesce a capire da dove iniziare e come riconoscere la conclusione? Documentare significa rendere esplicite queste informazioni, non allungare un elenco di clic.
Definire perimetro e punto di partenza
Scrivi a cosa serve il processo e a quali casi si applica. Indica ruolo, autorizzazioni e materiali necessari senza inserire password o segreti nel documento. Se un prerequisito manca, spiega chi può fornirlo e dove fermarsi, invece di lasciare al lettore il compito di improvvisare.
Dichiara che cosa resta fuori. Una procedura per una richiesta ordinaria non deve sembrare valida anche per un'eccezione sensibile. Collegala ai riferimenti appropriati e identifica il proprietario del documento, così le domande non diventano una ricerca casuale dell'ultima persona che l'ha usata.
Descrivere azioni e risultati osservabili
Per ogni passaggio indica l'azione e ciò che dovrebbe risultare. Se serve una schermata, limita l'immagine alla parte pertinente e rimuovi dati non necessari. I nomi dei pulsanti aiutano, ma non devono essere l'unico elemento: quando l'interfaccia cambia, il lettore deve capire ancora l'obiettivo.
Inserisci le eccezioni frequenti vicino al punto in cui si presentano. Non scrivere soltanto contattare l'assistenza: specifica quale canale usare e quali informazioni raccogliere senza esporre credenziali. Un risultato inatteso deve avere una risposta, anche quando la risposta è fermarsi.
Provare e mantenere il documento
Fai eseguire un caso rappresentativo a una persona del ruolo previsto. Osserva dove chiede chiarimenti e aggiorna la procedura, senza suggerire ogni passo a voce per far sembrare riuscita la prova. L'obiettivo è migliorare il testo, non esaminare il collega.
Aggiungi data di revisione e responsabilità dell'aggiornamento. Quando cambiano sistema, regole o ruoli, rivedi il percorso e i collegamenti. Conserva le versioni secondo le esigenze applicabili, rendendo però evidente quale sia quella corrente da usare.
| Sezione | Domanda del lettore | Contenuto utile |
|---|---|---|
| Scopo | Questo caso rientra qui? | Perimetro e casi esclusi |
| Prerequisiti | Che cosa mi serve? | Ruolo, strumenti e accessi autorizzati |
| Passaggi | Come so che è riuscito? | Azione e risultato osservabile |
| Eccezioni | Che cosa faccio se non torna? | Arresto, riferimento e informazioni da raccogliere |
- Scegli un caso e il ruolo che dovrà eseguirlo.
- Scrivi prerequisiti e risultati oltre ai clic.
- Prova il testo con una persona diversa dall’autore.
- Assegna revisione e proprietà della versione corrente.
Domande frequenti
Meglio testo o screenshot?
Usali in funzione del passaggio. Il testo spiega scopo e risultato; un'immagine mirata può chiarire un'interfaccia. Nessuno dei due sostituisce la verifica con un lettore reale.
Devo descrivere ogni eccezione possibile?
Inizia dalle eccezioni importanti e frequenti, indicando un punto di arresto e un riferimento per le altre. Un documento infinito può diventare meno utilizzabile.
Chi aggiorna la procedura quando cambia il software?
Il proprietario assegnato deve coordinare la revisione con chi conosce il processo. Senza un responsabile, anche un documento corretto tende a diventare una fotografia del passato.
