Uno dei più grandi pezzi di documentazione che abbia mai letto è the TeXbook di Donald Knuth, il manuale del sistema di composizione TeX , e l'ho usato nella mia prima analisi .
Per quanto posso dire, il tipo di informazioni trasmesse dalla documentazione rientra in tre categorie: ricetta, riferimento e conoscenza esperta che Descritto qui di seguito.
Quali categorie mi mancano?
Recipe
Una ricetta risponde a una domanda del tipo "come risolvo il problema con questo software?" e lega il mondo problematico con le caratteristiche del software. Capitoli 3, 7 e 8 nel TeXbook rispondi a domande come "Come eseguo TeX?" o "Come digito il testo?" e fornisci all'utente le ricette. Altri pacchetti software spesso contengono procedure di installazione o backup che rientrano in questa categoria.
Riferimento
Un riferimento documenta tutti i dettagli necessari su qualche pezzo di software. È utile per l'utente sapere che "questa funzione è utile per risolvere questo problema" e voler sapere se può parametrizzare "questa funzionalità" per risolvere un problema vicino. È anche utile per la risoluzione dei problemi del software quando fornisce risultati inaspettati. Capitolo 14 "Come TeX rompe i paragrafi in linee" in TeXbook è un esempio di testo di riferimento. Le pagine di manuale UNIX appartengono quasi sempre a questa categoria.
Conoscenze degli esperti
Anche le conoscenze specialistiche relative al problema risolto dal software appartengono alla documentazione del software. I motivi per questo sono almeno:
-
Gli utenti non sono esperti nell'area in cui il software è utile.
-
Gli esperti utilizzano una terminologia e metodologie diverse per descrivere o risolvere i problemi.
Per 1. i matematici che leggono il TeXbook imparano anche le nozioni di base del design e del layout: si rendono conto che esiste una conoscenza strutturata in quest'area e apprendono i nomi di i concetti di base coinvolti, in modo che possano esprimere i problemi e ottenere aiuto. Per 2. è utile "correggere la notazione" nella documentazione del software e questo è meglio fare fornendo alcune informazioni di alto livello o di sfondo.
Quindi la conoscenza esperta contenuta nella documentazione dell'utente vincola l'organizzazione concettuale del problema, come è noto ai progettisti del software all'organizzazione concettuale del problema, come è noto agli utenti del software.