Prodotto di lavoro: Guida allo stile del manuale
Questo artefatto descrive come devono essere sviluppati i manuali di supporto per l'utente finale.
Scopo

Lo scopo della guida allo stile dei manuali è di descrivere le convenzioni stilistiche da utilizzare per sviluppare i materiali di supporto utente. Una guida allo stile dei manuali fornisce dei suggerimenti e delle regole sull'ortografia di termini generici e specifici per dominio, lo stile delle frasi e le problematiche relative alla scrittura tecnica.

Relazioni
RuoliResponsabile: Modificato da:
Input inObbligatorio:
  • Nessuno
Facoltativo: Esterno:
  • Nessuno
Proprietà
Facoltativo
PianificatoYes
Personalizzazione
Opzioni di rappresentazione

E' necessaria una guida allo stile dei manuali se c'è una quantità significativa di documentazione utente, inclusa la documentazione stampata e in linea.

Utilizzare le guide di stile esistenti, come [HAC97] e [MOS98], poiché ci sono pochi buoni manuali disponibili su questo argomento.