Struttura della documentazione
La nostra documentazione suddivide le informazioni in tre diversi tipi di argomenti, in base al contenuto.
- Descrizioni dell’interfaccia utente
-
Argomenti che descrivono le funzionalità degli elementi dell’interfaccia utente ed elencano le opzioni e le impostazioni di finestre di dialogo, pannelli e altri elementi.
- Descrizioni dei concetti base
-
Argomenti che descrivono i concetti e spiegano le funzionalità di una specifica funzione del software.
- Descrizioni delle procedure
-
Argomenti che forniscono istruzioni passo a passo per l’esecuzione di una specifica operazione. Questi argomenti forniscono spesso un esempio del motivo per cui seguire i passaggi descritti, oltre a un breve riepilogo del risultato, comprese le conseguenze di cui è importante essere a conoscenza.
A causa di questa divisione delle informazioni, la struttura della nostra documentazione funge da riferimento che è possibile consultare per ottenere informazioni o istruzioni specifiche secondo necessità, piuttosto che una guida da leggere dall'inizio alla fine.
Gli argomenti descrittivi non mostrano come eseguire un’operazione, mentre gli argomenti procedurali non riportano spiegazioni di specifici elementi, funzioni o altro. Per trovare informazioni generali su determinati elementi o concetti, si consiglia di ricercarli per nome, cercando ad esempio il termine “eventi”. Per individuare le istruzioni per l’esecuzione di azioni particolari, si consiglia di includere un verbo pertinente nella propria ricerca, ad esempio “registrazione”.
I collegamenti in fondo agli argomenti consentono di raggiungere ulteriori contenuti pertinenti. É anche possibile controllare la barra laterale per trovare argomenti correlati nella struttura della documentazione.