Documentazione del prodotto
Aiuta gli utenti a completare le attività supportate dalla tua applicazione
Offri agli utenti guide pratiche che spiegano i percorsi dell'applicazione e li aiutano a portare a termine le loro attività.
Trasforma le funzionalità del prodotto in istruzioni pratiche
- Prepara l'ambito della guida
Esamina le sezioni della documentazione e il loro pubblico di riferimento.
- Rispondi alle domande sui contenuti
Chiarisci quali flussi di lavoro e informazioni deve spiegare una guida.
- Segui il servizio pubblico
Esamina l'avanzamento della costruzione e l'indirizzo del sito di documentazione.
Spiega come usare l'applicazione
La documentazione completa la presentazione del prodotto con istruzioni pratiche. Inizia con la guida introduttiva, poi accompagna gli utenti nei flussi di lavoro che l'applicazione supporta davvero.
La configurazione della documentazione mostra le definizioni delle sezioni e le domande. Fornisci un contesto che aiuti a spiegare un'attività nella lingua dell'utente.
Mantieni la guida collegata all'applicazione funzionante
Supporta una prima azione utile. Una guida introduttiva offre ai nuovi utenti un percorso breve verso il prodotto. Deve spiegare da dove iniziare, quali informazioni servono e quale risultato conferma che l'attività è completata.
Spiega un flusso di lavoro ricorrente. Una guida dettagliata segue le etichette e le azioni reali dell'applicazione. Prerequisiti, passaggi numerati e un risultato atteso aiutano chiunque a ripetere un'attività aziendale senza dover interpretare una descrizione generica della schermata.
Rispondi a una domanda trasversale. Alcune domande riguardano account, costi o pubblicazione anziché una singola schermata. Una FAQ fornisce una risposta concisa e rimanda alla guida pertinente, mantenendo la procedura in un unico posto invece di duplicarla in tutto il sito.
Mantieni le guide collegate al prodotto
Rivedi la documentazione dopo una modifica significativa dell'applicazione. Una guida deve usare le etichette e il comportamento che gli utenti vedono davvero.
La documentazione funziona su un proprio servizio pubblico. Collegala dal sito web e verifica le guide nelle lingue in cui pubblica il tuo progetto.
Aiuta un utente a completare l'attività successiva
Una guida pratica spiega da dove iniziare, quali informazioni servono e come verificare il risultato. Il suo valore sta nell'aiutare il lettore ad agire nell'applicazione.
Usa le guide correlate per continuare il percorso quando l'attività attraversa più aree. Rivedi la documentazione quando una schermata cambia, così le istruzioni restano utili dopo un'evoluzione.
Dalle funzionalità concordate a un aiuto utile
Prepara l'ambito della guida. Esamina le sezioni della documentazione e le attività che devono spiegare. Mantieni chiari l'utente di riferimento e il comportamento dell'applicazione.
Fornisci il contesto mancante. Rispondi alle domande su prerequisiti, regole e risultati. Il testo deve usare l'interfaccia reale invece di controlli inventati.
Verifica dopo la pubblicazione e le modifiche. Segui una guida nell'applicazione, verificane le lingue e i link correlati, poi riprendila quando l'attività sottostante cambia.
Rendi il prodotto più facile da usare dopo la prima visita
Fornisci istruzioni che portano a un risultato, accanto alla presentazione pubblica di ciò che fa l'applicazione.
Domande sulla documentazione del prodotto
Una pagina di funzionalità aiuta un potenziale cliente a capire la funzionalità e il suo valore. Una guida aiuta un utente a svolgere l'attività, con i controlli reali, i prerequisiti e il risultato. Si completano a vicenda.
Gli strumenti della documentazione mostrano le definizioni delle sezioni e le domande. Esamina le attività supportate dall'applicazione, fornisci il contesto mancante e segui l'avanzamento della scrittura.
Il progetto pubblica le guide localizzate disponibili per il suo ambito. Verifica ogni lingua pubblicata, così mantiene la procedura completa e le etichette corrette dell'interfaccia.
Dopo una modifica che riguarda l'attività, i suoi controlli o il risultato atteso. Confronta il testo con l'applicazione funzionante invece di presumere che le istruzioni originali siano ancora valide.
Un riferimento agli endpoint appartiene a un progetto con un'API attiva e funzionante. Usa le operazioni attive e il riferimento effettivo; le route pianificate non bastano a documentare un'integrazione utilizzabile.