Come classificare le informazioni nella documentazione per l'utente finale?

7

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:

  1. Gli utenti non sono esperti nell'area in cui il software è utile.

  2. 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.

    
posta Michael Le Barbier Grünewald 24.11.2013 - 18:06
fonte

4 risposte

3

Penso che tu abbia fatto un ottimo lavoro riassumendo la maggior parte dei tipi di documentazione in queste tre categorie. Vorrei aggiungere altri due:

Conoscenza per principianti / Bootstrapping

Potresti classificarlo sotto Ricette, ma penso che sia abbastanza diverso da meritare la sua categoria. Una ricetta presuppone già una conoscenza di base del sistema. Scrivere una ricetta per il cibo presuppone già una conoscenza di base del dominio di cucina: dovresti già sapere che cos'è un cucchiaino (se usi questo strano sistema di misure :)), come usare un forno, un forno a microonde, ecc.

Per qualcuno che non ha mai cucinato o prodotto cibo nella sua vita, vorrebbe una presentazione gentile dell'intero sistema, mostrando loro cosa possono fare e dando loro piccoli suggerimenti di freschezza lungo il percorso per mantenerli interessati.

Lo stesso vale per la documentazione. Un principiante rapidamente getterà via un libro di ricette, perché non hanno abbastanza conoscenza del dominio per apprezzare anche le ricette. Pertanto, hanno bisogno di alcune conoscenze per principianti o di bootstrap. Ecco alcuni punti su questo formato di documentazione:

  • Molto semplice, assicurandosi di spiegare ogni possibile termine non familiare. Questo può essere frustrante per alcuni utenti, ma è essenziale per educare chiunque guardi alla documentazione
  • Un sacco di piccoli esempi per mantenere l'utente interessato. Queste non sono ricette di per sé, ma sono piccole cose per mantenere il principiante interessato, sapendo che questo prodotto fa cose interessanti
  • Un sacco di link ad altri posti nella documentazione (Ricette, Conoscenze degli esperti, ecc.) dove possono imparare di più su alcuni dei concetti discussi
  • Abbastanza breve da essere facilmente digerito. Nessuno vuole leggere un romanzo introduttivo di 300 pagine

Marketing

Si potrebbe sostenere che questa non è realmente una "documentazione", ma spesso viene inclusa nella documentazione. Queste sono le descrizioni di "perché il nostro prodotto è così fantastico che dovresti usarlo". È una descrizione prolissa di come il prodotto supera la concorrenza. Questo è meno diffuso nel software open-source, ma lo vedete sempre nel software commerciale.

    
risposta data 06.12.2013 - 00:44
fonte
0

Diversamente varia se stai documentando software o hardware, ma possibilità:

  1. Il tutorial (non del tutto simile a quello che chiami Ricetta, dipende dalla situazione). Ma almeno un breve tipo di "Hello World", e forse di più. Alcune persone imparano meglio dagli esempi. Altri girano a destra al riferimento
  2. Installazione / trasformazione della cosa dannata su
  3. Disinstallazione / disattivazione off
  4. Interagire con altri "standard". Come funziona questo gizmo con Spring, XML, USB, Roku, LTE, CloudServices, ecc. Esiste un plugin Eclipse?
  5. Pericoli / avvertenze / requisiti / trucchi. Non utilizzare sott'acqua, funziona, ma alcune opzioni sono disabilitate in Windows RT, richiede Java 6 o versioni successive, non funziona con IE6, non l'abbiamo testato su Android 2.2 e versioni precedenti, ecc.
  6. FAQ, oltre a un link a qualsiasi aiuto in linea
  7. Note legali (se necessario, si spera che possiate evitarle) Le parti sono concesse in licenza da FooBar Corporation, le parti sono GNU, Non per uso in diagnostica, ecc ...
  8. Glossario (l'ho rubato dal commento di @ Marco)
risposta data 05.12.2013 - 21:44
fonte
0

Penso che Tutorial come categoria sia degna di distinzione dalle categorie elencate. Un tutorial non è una ricetta come l'hai descritta perché non è necessariamente un "come". Potrebbe essere una combinazione di "come", "perché" e "cosa" utilizzato per facilitare la comprensione di altri elementi. Una ricetta è solo "come" e sta da sola mentre un tutorial insegna un elemento che può essere completamente astratto e solo di qualsiasi uso in combinazione con altri elementi. In effetti si potrebbe anche considerare una ricetta come sottocategoria di Tutorial.

    
risposta data 06.12.2013 - 00:04
fonte
0

Penso che dovresti aggiungere una categoria " Indicizzazione ". Questo descrive il meccanismo per estrarre tutte le altre informazioni insieme tramite tag e collegamenti ipertestuali in modo che sia possibile accedervi in modo sensibile al contesto dall'applicazione e da un indice all'interno dell'applicazione. Se le informazioni non sono facilmente reperibili, gli utenti andranno su Google e salteranno la documentazione.

    
risposta data 06.12.2013 - 01:02
fonte

Leggi altre domande sui tag