Cinque punte per scrivere la documentazione tecnica

La creazione di documentazione tecnica fa parte di fare il lavoro nel settore IT. Manuali tecnici, istruzioni specifiche tecniche, guide di supporto, manuali operativi - ciascuno sono tipi di documentazione tecnica e sono una parte del lavoro. Un sacco di ruoli tecnici nel settore IT prendere parte al processo di documentazione. Si potrebbe semplicemente sembrare semplice da mettere solo alcune parole e diagrammi insieme, un sommario e pensare ad esso come un documento tecnico, ma &'; SA poco più. I &'; ve elencati cinque suggerimenti di seguito su come scrivere grandi documentazione tecnica

Tabella Usa A ben strutturato di
Contenuti

​​Il sommario è tra la sezione più importante di un documento.. Il sommario elenca ciò è infatti nel documento e come è organizzato. E 'usato per aiutare gli utenti a capire che il documento fornisce le informazioni che stanno cercando. Esaminando la tabella dei contenuti, sono in grado di vedere facilmente se ha che cosa hanno bisogno, o se hanno bisogno di leggere un altro documento.

Un ulteriore vantaggio di avere un tavolo ben strutturata di contenuti è che permette al lettore per trovare le informazioni di cui hanno bisogno in fretta. Microsoft Word, Adobe PDF e anche altre applicazioni di documenti consentono link cliccabili del sommario. Ciò consente di fare clic l'elemento o il numero di pagina e vi porterà a quella pagina. . Molto utile per trovare argomenti veloci

Be
sintetica ma approfondita

Essendo un documento autore tecnico, &'; s difficile sapere realmente quale importo e che tipo di informazioni per mettere in questo documento. Per scrivere un grande documento, cercate di essere breve, ma esauriente. Ciò significa non andare avanti e avanti e in tutti i tipi di dettaglio su alcuni settori che non sono necessari dal lettore. Non è facile dire che cosa s 'rilevante e ciò che isn &'; t - ma fare un tentativo di prendere in considerazione il lettore e target quando &'; re a scrivere il documento. Se siete troppo “ prolisso &"; o utilizzare troppe informazioni dove &'; s inutile, girerà i lettori fuori e ha vinto &';. t è un documento efficace

essere coerente in tutto il documento

La coerenza è un modo importante per migliorare un documento. Sarà farlo sembrare più professionale, e in realtà più leggibile per l'utente. Quando dico coerenza, voglio dire la regolarità sia nel gergo utilizzato e la formattazione sta applicando. Alcuni individui hanno vinto &'; t notato questo. Tuttavia, se si e' re la composizione di un documento tecnico, it &'; s più che probabile che per gli altri utenti tecnici, che sono di solito dettaglio a fuoco persone. Assicuratevi che il vostro documento usa la stessa formattazione in tutto. Provate a rompere i dati e rendere comprensibile agli utenti facendo uso di spazio bianco in modo efficace.

Utilizzando le stesse espressioni è anche raccomandato. Questo probabilmente in modo che l'utente che si conosce &'; re a scrivere la stessa cosa utilizzando le stesse parole. Se si utilizzano parole come sinonimi, ad esempio “ &" ;, Desktop “ &" ;, PC “ &" ;, calcolatore che potrebbe confondere l'utente, quando effettivamente dire la stessa cosa. Che &'; sa esempio veloce, ma l'idea è che si dovrebbe scegliere il periodo di un e rimanere con esso

Keep It preciso e senza errori

E 'quasi superfluo dire che la documentazione tecnica davvero. dovrebbe essere esente da errori. Come ho già detto, non pochi lettori del documento saranno altri utenti tecnici e non ci &'; s abbastanza buona possibilità errori starà a loro. In aggiunta a ciò, se gli errori don &'; t saltano fuori, quindi fornisce loro informazioni sbagliate per quanto riguarda il sistema o area che si &';! Re documentare - che sconfigge l'obiettivo del documento

Evitare grande schermo Cattura

Facendo uso di catture di schermo o screenshot all'interno documentazione è sicuramente un modo efficace di spiegare il vostro punto per il lettore. E &'; s in primo luogo utile per i processi di documentazione di software o di supporto, che sono facili da prendere screenshot del. Tuttavia, schermi di computer hanno ottenuto più grande nel corso degli anni, ma fogli A4 sono sempre state le stesse dimensioni.

Questo lascia una inclinazione di integrare grandi screenshot in un documento, che rende gli screenshot piccola e inefficace. Compreso screenshot è una grande idea - don &'; t fraintendetemi - ma fare uno sforzo per includere solo le aree che sono legati alla sezione che si &'; re spiegare. Questo tende a portare ad ulteriori screenshot, ma saranno più efficaci e rendere il documento più leggibile Hotel  .;