Informazioni sul servizio
TradottoScrivo documentazione tecnica e aiuto per il prodotto che le persone leggono realmente: una guida per l'utente, un centro assistenza, un riferimento API. Il lavoro inizia smontando il prodotto. Lo esamino come farebbe un neofita, annotando ogni punto in cui mi sono bloccato e raccogliendo i compiti reali con cui gli utenti arrivano. La struttura cresce da quei compiti, non dal tuo albero di menu: prima il lancio e il primo piccolo successo, poi il lavoro quotidiano, e solo dopo i scenari complessi di cui pochi hanno bisogno ma che occupano la maggior parte del tempo del team di supporto.
Ogni articolo è un insieme di passaggi con screenshot, con didascalie in modo che il lettore non debba mai indovinare quale pulsante si intende. Una sezione separata tratta degli errori comuni e di cosa fare al riguardo: il testo sullo schermo, il motivo dietro di esso, la via d'uscita. La parte API contiene esempi di richieste e risposte per ogni metodo, spiega i campi e i codici di stato, e dice chiaramente cosa torna in caso di errore. Un glossario tiene i termini del prodotto in un unico posto, in modo che l'interfaccia, l'aiuto e le risposte del supporto usino le stesse parole, e una breve guida di stile fissa il tono e la formulazione, in modo che il testo rimanga una voce anche quando altre persone vi aggiungono successivamente.
Ogni istruzione è verificata passando attraverso i passaggi sul prodotto live; nulla scritto dalla memoria di uno sviluppatore, senza quella verifica, entra nell'aiuto. Chiavi, token e credenziali di test negli esempi sono sostituiti con segnaposto. La documentazione per una funzionalità non completata è contrassegnata come bozza e non viene mai presentata come pronta.
— walkthrough del prodotto e un elenco dei veri compiti degli utenti
— struttura di aiuto dal primo lancio a scenari avanzati
— istruzioni passo-passo con screenshot e didascalie
— una sezione sugli errori comuni e cosa fare al riguardo
— riferimento API con esempi di richieste e risposte
— glossario di termini più una breve guida di stile e tono
— ogni istruzione ricontrollata sul prodotto live
— fonti consegnate in un formato facile da modificare ulteriormente
Ogni articolo è un insieme di passaggi con screenshot, con didascalie in modo che il lettore non debba mai indovinare quale pulsante si intende. Una sezione separata tratta degli errori comuni e di cosa fare al riguardo: il testo sullo schermo, il motivo dietro di esso, la via d'uscita. La parte API contiene esempi di richieste e risposte per ogni metodo, spiega i campi e i codici di stato, e dice chiaramente cosa torna in caso di errore. Un glossario tiene i termini del prodotto in un unico posto, in modo che l'interfaccia, l'aiuto e le risposte del supporto usino le stesse parole, e una breve guida di stile fissa il tono e la formulazione, in modo che il testo rimanga una voce anche quando altre persone vi aggiungono successivamente.
Ogni istruzione è verificata passando attraverso i passaggi sul prodotto live; nulla scritto dalla memoria di uno sviluppatore, senza quella verifica, entra nell'aiuto. Chiavi, token e credenziali di test negli esempi sono sostituiti con segnaposto. La documentazione per una funzionalità non completata è contrassegnata come bozza e non viene mai presentata come pronta.
— walkthrough del prodotto e un elenco dei veri compiti degli utenti
— struttura di aiuto dal primo lancio a scenari avanzati
— istruzioni passo-passo con screenshot e didascalie
— una sezione sugli errori comuni e cosa fare al riguardo
— riferimento API con esempi di richieste e risposte
— glossario di termini più una breve guida di stile e tono
— ogni istruzione ricontrollata sul prodotto live
— fonti consegnate in un formato facile da modificare ulteriormente
