Che cos'è la documentazione software?
Il software si riferisce a routine e programmi sviluppati per un sistema informatico che consente l'uso di eseguire attività o interagire in altro modo con il computer. Il software potrebbe essere fornito dal produttore come componente di sistema o creato come applicazioni separate dal produttore o da terze parti. La documentazione è una descrizione di un prodotto e come utilizzarlo. La documentazione del software descrive le applicazioni software e come usarle.
La documentazione stampata del software, a volte indicata come manuali del software, è spesso impostata come un libro, con una pagina del titolo, un sommario, un corpo e un indice e spesso hanno alcuni componenti tipici. Il primo componente di cui la maggior parte degli utenti ha bisogno è una guida all'installazione e vengono fornite guide separate per i vari sistemi operativi su cui il software lavora, se necessario. La guida all'installazione elenca le specifiche necessarie per eseguire il software, inclusi i sistemi operativi del computer, la RAM, lo spazio sul disco rigido, una connessione Internet e qualsiasi altro requisito o componente aggiuntivo, come le periferiche. Questo è seguito da istruzioni dettagliate per l'installazione, che potrebbero provenire da un CD-ROM, un DVD o un download, ad esempio. In genere vengono spiegate tutte le caratteristiche insolite dell'installer e la spiegazione delle scelte di installazione personalizzate, come posizioni alternative o installazioni semplificate.
Una guida di “avvio rapido” è spesso la parte successiva della documentazione software stampata utilizzata. Riprendendo da dove termina la guida di installazione, la Guida di avvio rapido aiuta l'utente a iniziare con il software e le sue operazioni di base. Questa sezione può essere organizzata in vari modi, a seconda del software specifico. Un metodo popolare per le applicazioni orientate alle attività è un'introduzione basata su progetto in cui l'utente apprende le funzionalità di base del software durante il completamento di alcune mini-lezioni.
Altri elementi che ci si aspetterebbe di trovare nella documentazione del software stampato includono un esaurimento completo delle funzionalità, con enfasi sulle funzionalità nuove all'ultima versione; un elenco di aggiornamenti rispetto alle versioni precedenti, possibilmente includendo bug corretti; informazioni su come ottenere supporto tecnico; spiegazioni di messaggi di errore; e informazioni per utenti avanzati o "potenti". I giochi e altre applicazioni software possono includere cheat sheet o suggerimenti nella loro documentazione.
La documentazione del software stampato non è l'unico tipo. Innanzitutto, la documentazione stampata può anche essere disponibile online o in pdf. Documentazione aggiuntiva può anche essere disponibile sotto forma di suggerimenti e schermate di aiuto all'interno dell'applicazione stessa, FAQ - elenchi di domande frequenti insieme a risposte, articoli ricercabili, formazione Web, video e altri formati.
La documentazione del software varia in termini di qualità e ciò è particolarmente vero per i manuali del software. Quelli buoni possono essere eccellenti, mentre quelli che non sono ben eseguiti possono lasciare agli utenti molte domande. Ci sono anche utenti che non si preoccuperanno di cercare la documentazione prima di porre domande sui forum del produttore del software.