Il software si riferisce a routine e programmi sviluppati per un sistema informatico che ne consentono l’uso per 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 terzi. La documentazione è una descrizione di un prodotto e di come utilizzarlo. La documentazione del software descrive le applicazioni software e come utilizzarle.
La documentazione stampata del software, a volte indicata come manuali del software, è spesso impostata come un libro, con un frontespizio, 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 funziona il software, secondo necessità. La guida all’installazione elenca le specifiche necessarie per eseguire il software, inclusi i sistemi operativi del computer, la RAM, lo spazio su disco rigido, una connessione Internet e qualsiasi altro requisito o componente aggiuntivo, come le periferiche. Questo è seguito da istruzioni passo passo per l’installazione, ad esempio da un CD-ROM, da un DVD o da un download. In genere vengono spiegate tutte le caratteristiche insolite del programma di installazione 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 del software stampata utilizzata. Riprendendo da dove si interrompe la guida all’installazione, la guida Quick Start 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 progetti in cui l’utente apprende le funzionalità di base del software mentre completa alcune mini-lezioni.
Altri elementi che ci si aspetterebbe di trovare nella documentazione del software stampata includono una panoramica completa delle funzionalità, con enfasi sulle funzionalità nuove dell’ultima versione; un elenco di aggiornamenti rispetto alle versioni precedenti, eventualmente inclusi bug corretti; informazioni su come ottenere supporto tecnico; spiegazioni dei messaggi di errore; e informazioni per utenti avanzati o “power”. I giochi e altre applicazioni software possono includere trucchi o suggerimenti nella loro documentazione.
La documentazione stampata del software non è l’unica. Innanzitutto, la documentazione cartacea può essere disponibile anche online o in formato pdf. Potrebbe anche essere disponibile ulteriore documentazione sotto forma di suggerimenti sugli strumenti e schermate di aiuto all’interno dell’applicazione stessa, FAQ – elenchi di domande frequenti con risposte, articoli ricercabili, formazione web, video e altri formati.
La documentazione del software varia parecchio in termini di qualità, e questo è 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.