Ogni domanda a cui l'assistenza risponde due volte è una guida che ancora non esiste. Scrivere documentazione però richiede tempo, e di solito perde contro il prossimo ticket urgente. Lo strumento Articolo di documentazione scrive una prima bozza dettagliata partendo da un argomento e da un insieme di istruzioni, così la guida esce dalla lista delle cose da fare.
Inserisci l'argomento, per esempio come esportare le fatture, e le istruzioni, cioè a chi è rivolto l'articolo, i passaggi reali nel tuo prodotto, il formato e cosa evitare. Lo strumento scrive l'articolo seguendo queste indicazioni. Il tuo team poi verifica ogni passaggio sul prodotto vero e lo pubblica nel centro assistenza.
Fa parte della famiglia Assistenza clienti. Trasforma in guide le risposte ai ticket che si ripetono, e usa il Generatore di FAQ per le pagine brevi di domande e risposte.
Cosa ottieni
- Un articolo di documentazione dettagliato sull'argomento che indichi
- Struttura e formato che seguono le tue istruzioni, come passaggi numerati o sezioni
- Un linguaggio semplice, adatto al pubblico che descrivi
- L'articolo nella lingua che scegli, così le stesse istruzioni servono anche per un centro assistenza in un'altra lingua
Cosa compili
- Argomento obbligatorio
-
Cosa spiega l'articolo, es. Come esportare le fatture in CSV.
- Istruzioni obbligatorio
-
Pubblico, passaggi o fatti reali, formato, lunghezza e cosa evitare.
Come si usa, passo dopo passo
-
Formula l'argomento come un compito
Le guide funzionano meglio quando spiegano una sola operazione, come reimpostare la password, invece di un tema ampio come la gestione dell'account.
-
Scrivi i passaggi reali nelle istruzioni
Nomi dei menu, pulsanti e impostazioni esattamente come compaiono nel tuo prodotto. Lo strumento non vede la tua interfaccia.
-
Indica pubblico e formato
Di' chi legge e come deve essere impaginato l'articolo, per esempio passaggi numerati e una sezione finale per i problemi più comuni.
-
Genera e prova i passaggi
Segui l'articolo dentro il prodotto e correggi tutto ciò che non corrisponde prima di pubblicarlo.
Esempio, input e risultato
Input
- Argomento
- Come esportare le fatture in CSV
- Istruzioni
- Per utenti non tecnici. Passaggi, menu Fatture, filtro per data, Esporta, scegli CSV. Passaggi numerati, breve sezione per la risoluzione dei problemi.
Risultato
Puoi scaricare le tue fatture in un file CSV per aprirle in un foglio di calcolo.
1. Apri il menu **Fatture**.
2. Usa il filtro per data per scegliere il periodo che ti serve.
3. Fai clic su **Esporta**.
4. Seleziona **CSV** e conferma.
## Risoluzione dei problemi
**Il file è vuoto.** Controlla che il periodo scelto nel filtro contenga almeno una fattura.
Esempio illustrativo scritto dalla redazione per mostrare il formato atteso.
Consigli per risultati migliori
- Incolla le etichette esatte di pulsanti e menu. Chi legge la documentazione la segue alla lettera.
- Inserisci le domande che i clienti fanno davvero nei ticket, con le loro parole, così l'articolo risponde proprio a quelle.
- Chiedi una breve sezione finale sui problemi più comuni. Spesso è quella che evita il ticket successivo.
- Se il prodotto è in inglese ma la guida è in italiano, scrivi le etichette nella lingua dell'interfaccia, così chi legge le ritrova sullo schermo.
Chi lo usa, e per cosa
Team di un software che costruisce il centro assistenza
Prepara il primo gruppo di guide pratiche partendo dai ticket più frequenti.
Responsabile dell'assistenza che vuole ridurre le domande ripetute
Trasforma la risposta a un ticket frequente in un articolo pubblico che gli operatori possono linkare.
Product manager al rilascio di una novità
Scrive la bozza della guida a una nuova funzione partendo dalle note di rilascio.
Procedure interne
Documenta una procedura interna, come l'avvio di un nuovo cliente, per la wiki del team.
Limiti e buone pratiche
- Lo strumento non vede il tuo prodotto. I passaggi che non gli hai dato possono risultare generici o sbagliati, quindi prova ogni articolo.
- Non pubblica nel centro assistenza e non aggiorna gli articoli quando il prodotto cambia.
- Scrivi i passaggi completi fin dal primo tentativo, perché ogni nuovo giro è una generazione che consuma crediti del tuo piano. Piani e crediti sono nella pagina prezzi.
Domande frequenti
Cosa rende efficace un articolo del centro assistenza?
Un compito per articolo, un titolo che corrisponde a quello che gli utenti cercano, una breve introduzione, passaggi numerati con le etichette esatte del prodotto e una sezione per i problemi più comuni. Anche gli screenshot aiutano. Lo strumento scrive il testo, il tuo team aggiunge le immagini e prova i passaggi.
Cosa devo scrivere nel campo Istruzioni?
Il pubblico, i passaggi o i fatti reali, il formato e le eventuali regole, per esempio evitare termini tecnici o restare sotto le 400 parole. Più le istruzioni sono precise, meno la bozza va corretta, perché lo strumento le segue da vicino.
Può scrivere documentazione per sviluppatori o per un'API?
Può scrivere articoli esplicativi per sviluppatori se nelle istruzioni gli dai endpoint, parametri ed esempi. Non può leggere il tuo codice o la tua API, quindi ogni richiesta e risposta deve arrivare da te ed essere provata. Per il codice vero e proprio ci sono gli Strumenti per sviluppatori.
In cosa è diverso da un articolo per il blog?
Un articolo di documentazione aiuta qualcuno a completare un'operazione nel tuo prodotto, quindi è preciso, letterale e concentrato sui passaggi. Un articolo del blog informa o convince un pubblico più ampio. Per il blog usa l'Articolo SEO e tieni questo strumento per le pagine di assistenza e della knowledge base.
Posso usarlo per la documentazione interna?
Sì. Procedure, guide di inserimento per i nuovi colleghi e checklist per il team funzionano bene, purché le istruzioni contengano i passaggi reali. Togli i dati riservati che non vuoi nello spazio di lavoro e conserva la versione finale dove il team tiene la documentazione interna.
Provalo nel tuo spazio di lavoro
Inizia gratis, senza carta di credito. Quando ti serve di più, la suite cresce con te, dal Lite all'Agency.
Accedi o crea un account gratuito, lo strumento si apre nel tuo spazio di lavoro.