Indicazioni sulla scrittura per la documentazione di Adobe

Queste linee guida sono applicabili se stai creando una nuova documentazione o aggiornando la documentazione esistente.

Effettua le seguenti operazioni:

  • Controlla l’ortografia e la grammatica degli articoli.
  • Utilizza un tono amichevole.
  • Utilizza frasi semplici. Sono più facili da comprendere e tradurre in altre lingue.

Linee guida sugli stili

Tieni presente quanto segue durante la scrittura della documentazione.

  • Scrivi in modo sintetico: non sprecare parole. Mantieni le frasi brevi e concise. Mantieni l’articolo mirato. Mantieni al minimo il numero di note.
  • Concentrati sul pubblico e sullo scopo: prima di iniziare a scrivere, stabilisci chiaramente chi sia il cliente e quale attività sta tentando di svolgere. Scrivi l’articolo per aiutare il cliente a svolgere quell’attività.
  • Utilizza esempi: fornisci esempi per spiegare i concetti.
  • Organizza i contenuti: crea delle sezioni per suddividere le istruzioni in gruppi di passaggi più gestibili. Aggiungi una schermata quando serve per maggiore chiarezza.

In questa pagina

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now