Molte organizzazioni producono strumenti interni o modificano strumenti disponibili in commercio per il proprio uso. Questi strumenti dovrebbero essere documentati in modo che siano utili agli altri nell';organizzazione.
Se questa documentazione non è stata creata o è scritta male, ti costa due volte:
* Il primo costo (attribuito a qualsiasi documento utente scadente) è il costo di risposta alle domande degli utenti (supporto tecnico).
* Il secondo costo deriva dal tempo perso dei dipendenti che cercano di capire il povero documento utente.
Persone che vivono in spazi ristretti - Hong Kong: le città più trafficate del mondo | BBC Two
I costi psicologici riguardano anche l';utente esterno e quello interno.
IL PRIMO COSTO: SUPPORTO TECNICO
Questo è il costo che si incorre quando si producono documenti utente poveri (o non). Sorge per qualsiasi utente quando ha bisogno di supporto tecnico. Per gli utenti esterni, il costo è il personale di supporto tecnico, le linee telefoniche gratuite, ecc.
Per gli utenti interni il costo è il tempo impiegato dallo sviluppatore o dal modificatore dello strumento per rispondere alle domande del suo collega. Si tratta di un costoso costo di supporto tecnico ... queste persone sono generalmente pagate più del personale di supporto tecnico. Quindi questo primo costo è ancora maggiore per la scarsa documentazione interna che per la documentazione scadente pubblicata al pubblico.
IL SECONDO COSTO: TEMPO E RISORSE PER GLI UTENTI
Per gli utenti esterni alla tua azienda, il secondo costo è assunto dagli utenti stessi o dai loro datori di lavoro. Questi utenti confusi stanno spendendo il tempo della loro azienda: il tempo perso cercando di far funzionare il prodotto e il tempo trascorso a occuparsi del supporto tecnico.
Per i tuoi utenti interni, questo costo è a carico della tua azienda. È il tuo dipendente - nel tuo tempo - che sta sprecando le risorse della tua azienda cercando di utilizzare un prodotto o un documento arcano. Qui è dove la tua documentazione interna carente ti costa due volte.
I COSTI PSICOLOGICI INFLUENZANO TUTTI I LETTORI
Oltre a questi tempi e costi monetari, ci sono i costi psicologici causati dalla scarsa documentazione degli utenti.
Per gli utenti frustrati al di fuori della tua azienda, la tua scarsa documentazione comporta una percezione negativa della tua azienda e dei suoi prodotti. Ciò potrebbe comportare la perdita di affari.
Per gli utenti all';interno della vostra azienda, il costo psicologico è diminuito il morale dei dipendenti, come evidenziato da queste possibili affermazioni:
* La nostra azienda ha prodotto questa spazzatura?
* Queste persone non sono taglienti come pensavo fossero.
* Se altri dipendenti possono produrre queste cose confuse, allora posso lavorare allo stesso livello.
Quindi il malore esterno alla tua azienda può costarti vendite future; la cattiva volontà all';interno della vostra azienda può costare in diminuzione del morale dei dipendenti.
SOLUZIONE: RECENSIONI INFORMALI
Una volta che qualcuno scrive un documento utente per uno strumento interno, tale documento dovrebbe essere esaminato in modo informale.
Autovalutazione
L';autore può eseguire la prima recensione da solo.
Utilizza il correttore ortografico del tuo word processor per correggere errori comuni. È possibile utilizzare il correttore grammaticale del word processor, tuttavia la maggior parte di questi sono inaccurati.
Prima di fare questa recensione, lascia riposare il documento per un giorno o due. Questo ti aiuterà a dimenticare cosa intendevi nella tua scrittura poco chiara. Quando fai la recensione e ti ritrovi a chiedere :cosa intendevo qui?: avrai trovato un posto nel documento che necessita di revisione.
Durante la revisione, immagina di essere utente dello strumento e lettore del documento. Immagina le attività che l';utente dello strumento vuole fare. Il documento consente al Reader di trovare ciò di cui ha bisogno? La scrittura è accurata (descrive correttamente lo strumento), è chiaro e completo? Apporta le modifiche che migliorerebbero il documento.
REVISIONE ESTERNA
Quindi, se possibile, utilizzare un revisore esterno (all';interno della propria azienda). Per fare questo, lo scrittore dovrebbe:
1. Trova un potenziale utente dello strumento. Questo dovrebbe essere qualcuno che non ha già familiarità con lo strumento, e come simile al pubblico di destinazione dello strumento come ragionevole.
2. Chiedere al revisore di utilizzare il documento per guidarlo nell';utilizzo dello strumento. Richiedere commenti sul documento. Nota le modifiche suggerite, aggiunte, cancellazioni, chiarimenti richiesti dal revisore. Alcune domande da porre potrebbero includere:
* Il documento ti dice cosa devi sapere?
* È facile trovare quello che ti serve nel documento?
* Il documento risponde alle tue domande? In caso contrario, quali domande non hanno risposta?
* Il documento è facile da seguire? In caso contrario, dove sono le aree problematiche?
3. Lo scrittore dovrebbe apportare le modifiche necessarie.
Se non riesci a eseguire questa recensione :semiformale:, chiedi a qualcuno che non sia tu stesso di leggere semplicemente il documento e di suggerire miglioramenti.
ATTENZIONE
Assicurarsi che il processo di revisione non diventi un';inibizione per coloro che scrivono la documentazione per gli utenti interni. Sottolineare un meccanismo cooperativo - non contraddittorio - il cui risultato è un lavoro di qualità. Non cercare di creare il documento utente perfetto.