Un articolo da un ticket tecnico risolto documenta un sintomo, ambiente verificato, soluzione testata e controllo del risultato. Rimuovi dati del cliente e limita le istruzioni alle condizioni dimostrate.
Scegliere un caso riproducibile
Conferma causa, soluzione e risultato. Chiudere un ticket non prova il successo. Senza conferma del cliente o test, non dichiarare le istruzioni verificate.
Scegli un sintomo. Non unire problemi diversi solo perché gestiti dallo stesso team.
Anonimizzare i materiali
Rimuovi nomi, indirizzi, documenti privati, account, identificativi di sessione e segreti tecnici. Controlla immagini separatamente.
Mantieni fatti necessari su prodotto, versione, ambiente, sintomo e condizione scatenante. Descrivi in sicurezza configurazioni identificabili preservando la causa. Non pubblicare la corrispondenza.
Usare sintomo–ambiente–soluzione
- Sintomo: cosa si vede e quando.
- Ambiente: prodotto, versione, sistema e configurazione.
- Condizione: come riconoscere il caso applicabile.
- Soluzione: passi testati per il caso.
- Controllo: esito di successo atteso.
- Limiti ed escalation: quando fermarsi o contattare supporto.
Diagnosi non equivale a riparazione. Raccogliere dati non è risolvere. Per proteggere informazioni usa la procedura confermata del prodotto.
Esempio fittizio
Non è un guasto Semly. In un'applicazione documentale 2.4.0, una lista già aperta non mostra un documento nuovo dopo una modifica confermata dei permessi. Ricaricare aggiorna la lista, non i permessi.
La sessione è iniziata prima della modifica. Il documento deve apparire in una vista appena aperta dello stesso account.
Salva lavoro non salvato e ricarica secondo le istruzioni reali. Verifica che il documento compaia e si apra con il permesso corretto. Se manca anche nella nuova vista, il caso non è confermato e serve altra diagnosi.
Spiegare i limiti
Indica solo versioni e configurazioni testate. Interfacce simili non dimostrano supporto su altre piattaforme.
Non promettere che ricaricare corregga permessi o dati mancanti. Altre cause richiedono altri procedimenti. La condizione evita passi irrilevanti.
Testare come un lettore
Un revisore tecnico riproduce il caso in sicurezza e segue il testo senza conoscere il ticket. Condizioni e successo devono essere espliciti.
Completa l'ambiente se mancano informazioni. L'istruzione non deve dipendere da conoscenze esclusive dell'autore.
Registrare verifica e traduzioni
Mantieni data e responsabile. Dopo cambi del prodotto controlla nuovamente condizioni e passi.
Le traduzioni conservano versione, sintomo, ordine e criterio di successo. I messaggi devono corrispondere all'interfaccia reale. Un'altra causa e soluzione formano un altro caso, non un'aggiunta scollegata.
