Come mantenere aggiornata la documentazione con screenshot

La documentazione visiva resta utile solo finché immagini, etichette e istruzioni corrispondono all'attività corrente. Un buon processo di manutenzione collega le modifiche del prodotto alle guide interessate, sostituisce soltanto i passaggi necessari, verifica la sequenza aggiornata e registra chi l'ha approvata, senza ricostruire ogni guida a ogni release.

In breve: registra per ogni guida la versione del prodotto verificata e il responsabile, controlla le modifiche in base alla schermata e all'attività interessate, sostituisci i passaggi coinvolti e infine esegui l'intera guida prima di aggiornare la data di revisione.

Assegna un responsabile e registra la versione verificata

Il responsabile garantisce l'accuratezza, ma non deve necessariamente scrivere ogni aggiornamento. Indica un ruolo in grado di confermare la procedura corrente e approvare le modifiche.

Conserva questi campi insieme a ogni guida visiva:

Responsabile della guida:
Versione verificata del prodotto o processo:
Ultima revisione:
Prossima revisione programmata:
Schermate o funzioni usate:
Etichette dell'interfaccia usate:
Posizione delle immagini sorgente:

Questi metadati trasformano una nota di rilascio in un elenco di possibili conseguenze sulla documentazione, evitando di dover cercare in ogni pagina pubblicata.

Usa le modifiche del prodotto come segnali di revisione

Una revisione attivata dagli eventi è più precisa di un semplice promemoria sul calendario. Avvia un controllo quando una release modifica un'etichetta, il layout di una schermata, un percorso di navigazione, un permesso, una funzione inclusa in un piano, un'esportazione, uno stato di errore o un valore predefinito usato in una guida.

La revisione periodica resta utile per le pagine non associate a un evento chiaro del prodotto. Scegli intervalli più brevi per procedure molto consultate, sicurezza, fatturazione, azioni distruttive e interfacce che cambiano spesso.

Collega la modifica ai passaggi interessati

La valutazione deve individuare quali istruzioni, screenshot, punti di controllo, domande frequenti e link dipendono dal comportamento cambiato. Non dare per scontato che basti sostituire l'immagine.

Per esempio, lo spostamento del pulsante Export può richiedere di aggiornare sia lo screenshot sia il testo che ne indica la posizione. Una modifica ai formati disponibili in un piano può interessare i passaggi principali, la tabella di confronto, le domande frequenti, la descrizione nei metadati e i link interni ai prezzi.

Usa questo controllo delle modifiche:

• Quale etichetta è cambiata?
• Quale controllo è stato spostato o ha cambiato stato?
• È cambiato l'ordine delle azioni?
• Sono cambiate la condizione iniziale o le autorizzazioni?
• È cambiato il risultato previsto?
• È cambiata una regola relativa al piano o alla disponibilità?
• Quali pagine della guida, didascalie, testi alternativi, domande frequenti e link lo citano?

Sostituisci soltanto i passaggi interessati

La sostituzione selettiva riduce il lavoro di revisione e lascia intatte le pagine ancora valide. Ricrea la guida partendo dallo stesso stato iniziale sicuro, poi acquisisci il passaggio modificato e una porzione sufficiente del contesto circostante per mantenere coerente la sequenza esistente.

Sostituisci più di una pagina quando la nuova interazione modifica l'ordine o lo stato visibile delle azioni successive. Non inserire un singolo screenshot nuovo in una sequenza precedente se il lettore si troverebbe a passare tra versioni incompatibili dell'interfaccia.

Action Capture può riacquisire in ordine la parte interessata della procedura. Confronta la nuova sequenza con la guida pubblicata, poi conserva soltanto le pagine necessarie a sostituire la sezione cambiata.

Ricontrolla testo, annotazioni e dati privati

Durante la modifica aggiorna etichette esatte, testo delle azioni, frecce, indicatori dei clic, ritaglio, Action Focus, sfocature e punti di controllo previsti. Le vecchie annotazioni possono indicare uno spazio vuoto anche quando, a prima vista, lo screenshot sembra simile.

Ripeti il controllo dei dati privati. Un account, menu, notifica o progetto di esempio acquisito di nuovo potrebbe mostrare informazioni assenti nella versione precedente.

Verifica l'intera guida

Il test di regressione deve partire dal primo passaggio e usare le condizioni iniziali pubblicate. Provare soltanto la pagina sostituita può nascondere un nuovo prerequisito o una modifica che altera il passaggio alla sezione interessata.

La guida aggiornata è pronta quando il lettore raggiunge lo stesso risultato dichiarato, tutte le etichette corrispondono, l'ordine delle pagine è corretto, i dati privati sono protetti e ogni link interno porta a una pagina visibile.

Registra la nuova versione verificata e la data di revisione soltanto dopo questa prova completa.

Archivia le vecchie versioni solo quando servono ai lettori

Le versioni storiche sono utili se i clienti continuano a usare release precedenti, se l'assistenza deve riprodurre comportamenti passati o se un processo regolamentato richiede la registrazione. Indica chiaramente la versione a cui si applicano e, se non rappresentano il percorso predefinito, escludi le vecchie guide dalla ricerca e dalla navigazione correnti.

Per la maggior parte dei contenuti di assistenza pubblici, il controllo versione o la cronologia dei documenti può conservare le versioni precedenti mentre l'URL pubblicato mostra il percorso verificato più recente. Evita di lasciare nella ricerca più pagine che differiscono soltanto per una versione del prodotto non più supportata.

Registra ogni intervento di manutenzione

Usa un registro sintetico per ogni aggiornamento:

Guida:
Responsabile:
Origine della modifica:
Passaggi interessati:
Testo aggiornato:
Immagini aggiornate:
Revisione della privacy completata:
Test completo dall'inizio alla fine:
Versione verificata:
Revisore:
Data della revisione:
Prossimo evento o data di revisione:

Il ciclo di manutenzione è concluso quando guida pubblicata, immagini, metadati e registro del responsabile descrivono tutti la stessa attività corrente. Usa Come creare una guida passo passo dai clic su Mac per riacquisire le pagine interessate e Action Capture per tenere unita la sequenza sostitutiva durante la revisione.