Come Creare un'Ottima Guida

Qualsiasi guida è mille volte migliore di nessuna guida. Quelle che seguono non sono regole, ma linee guida. Perfino noi qualche volta ci dimentichiamo di rispettarle tutte e talvolta dobbiamo tornare indietro e modificare qualche cosa. Sappiamo di essere umani e che tutti commettiamo errori. Queste guide diventeranno sempre meglio col passare del tempo, perciò non preoccuparti di conseguire un'assoluta perfezione fin da subito. Cerca invece di essere un pioniere!

Immagini davvero eccellenti sono l'elemento fondamentale per rendere attraente per i lettori il tuo manuale di riparazione. La realizzazione di immagini di qualità è perfettamente possibile anche con un equipaggiamento economico. Prenditi un po' di tempo per studiare i nostri tutorial fotografici.

Fotografia e testo dovrebbero supportarsi l'uno con l'altro. Si possono usare immagini supplementari per integrare le spiegazioni testuali e viceversa.

L'uso di parole vaghe come "cosa", "aggeggio" e "roba" porta a realizzare guide di riparazione ambigue. Se non sai come si chiama qualche cosa, fai del tuo meglio per scoprirlo tramite Google oppure chiedendo a qualcuno. I dispositivi possono avere diverse parti interne molto intricate: chiamare una parte "questa cosa" non aiuta nessuno!

L'orientamento dell'oggetto deve rimanere lo stesso per quanto possibile all'interno della guida. Il lettore deve essere in grado di identificare con grande facilità la posizione dell'oggetto. Se esegue una rotazione, inserisce una frase come "Gira il dispositivo" oppure "Ruota il dispositivo di 90° in senso orario" per aiutare il lettore a fare la stessa cosa.

Inserire un po' di informazioni generali è una grande cosa: perché fai questo, a chi è destinata questa guida, che cosa bisogna predisporre per poter eseguire le azioni della guida. È meglio, però, fermarsi qui: la maggior parte dei navigatori sul web rabbrividiscono all'idea di leggere un libro prima di riparare qualche cosa (quando è stata l'ultima volta che hai letto il manuale di istruzioni fornito con la tua TV?).

I link incrociati sono tuoi grandi amici. Inserisci link a quante più risorse possibili siano presenti in altre parti del sito.

Per quanto ci possa piacere le storia della bisnonna che mette il gelato nella sua borsa (una storia vera!), ci sono sedi più appropriate per raccontare queste storie. E il posto giusto non è a metà di un manuale di riparazione.

L'aggiunta di ulteriori informazioni pertinenti al soggetto rende più autorevole il tuo manuale di riparazione.

Le persone non useranno il tuo manuale di riparazione se non capiranno di che cosa stai parlando.

L'uso improprio dei pallini può creare un'enorme confusione. Spreca un secondo per informarti sul significato di ogni tipo di pallino prima di usarlo. In caso di dubbio, usa quello di base!

Se il dispositivo è abbastanza semplice, non servono note di rimontaggio. In qualche caso, invece, si richiedono istruzioni particolari. Ad esempio, smontare il display LCD di una MacBook è un'operazione decisamente intuitiva. Tuttavia, se non fai passare i cavi nelle giuste posizioni prima di rimontarlo, i contatti non corrisponderanno ai punti di connessione sulla scheda logica. I lettori ti ringrazieranno cordialmente si includerai dei piccoli consigli su come rimontare il dispositivo una volta che questo è ridotto in pezzi.

In determinate circostanze, immagini e testo possono non essere sufficienti. L'aggiunta di un diagramma o due (e il loro caricamento come immagini) aiuteranno certamente il lettore a capire come eseguire la riparazione.

L'aggiunta di troppi markup (indicatori colorati) renderà la tua immagine intricata e poco invitante per i lettori. Aggiungi il minimo indispensabile per spiegare di che cosa stai parlando, se proprio sei convinto che sia necessario un indicatore. Se ti sembra il caso di inserire quattro o cinque markup, faresti meglio a suddividere l'azione in passi multipli. In caso di dubbio, guarda qualche guida già fatta di iFixit!

Utilizza con parsimonia i titoli dei passi. L'aggiunta corretta di guide prerequisite creerà automaticamente una struttura di navigazione appropriata; quindi nella maggior parte dei casi non serve titolare i vari passi.

All'interno di una squadra "Io" non esiste, né deve esserci in quello che scrivi. Se nei tuoi manuali eviterai di usare frasi come "Io ho fatto questo", avrai un tono più autorevole.

Siamo qui per aiutarci l'un l'altro a imparare ad aggiustare le cose. Esprimi le tue idee politiche e le tue opinioni generali in altre sedi più appropriate.

Cerca di essere molto diretto nelle tue istruzioni per l'utente. Non cadere nella trappola del solo verbo essere e invece usa dei verbi più adatti a spiegare quello che stai cercando di dire.

Carica solo immagini e testo di cui sei l'autore o sui quali hai i diritti d'uso necessari.