Come scrivere un layout di istruzioni Manuale

Un manuale di istruzioni può essere semplice come un libro di cucina o complesso come un manuale di assemblaggio per un aereo di linea jet . In entrambi i casi , il design del manuale può aiutare o ostacolare quando si tenta di utilizzarlo . Un " layout" può significare una o entrambe due cose : l'ordine in cui viene presentata l'informazione , o il modo in cui le informazioni vengono visualizzate sulla pagina o schermata e le relazioni tra gli elementi grafici nella pagina o schermata . Definire il campo di applicazione del manuale di istruzioni e determinare gli elementi grafici e testuali si intende utilizzare prima di creare entrambi i tipi di layout.Things Hai bisogno
pagina software di progettazione /elaborazione testi
Delineando software ( opzionale)

Mostra Altre istruzioni
1

Creare uno schema per il manuale di istruzioni che riporta tutte le attività e sottoattività nell'ordine si decide . Microsoft Word contiene una funzione di delineare che automatizza il processo per voi .
2

Includere spazio nel vostro formato per tutte le varie parti di manuali di istruzioni , comprese quelle sezioni come sommario , un indice , diagrammi di parti che mostrano come assemblare loro , istruzioni d'uso e di eventuali altre sezioni rilevanti per il contenuto tecnico . Non saranno necessarie tutte le sezioni per tutti i manuali , quindi a seconda di cosa il vostro manuale è destinato , aggiungere o sottrarre questi dal contorno . Rendere il contorno più dettagliato possibile in modo che il manuale sarà più facile da scrivere in forma definitiva .
3

Decidere che cosa il formato del manuale sarà . Se si tratta di un insieme di compiti autonomi , come un libro di cucina , si hanno più opzioni di presentazione che se il manuale è un insieme di attività secondarie sequenziali che portano ad un risultato complessivo , come ad esempio un manuale che vi mostra come smontare un motore .

Se avete bisogno di replicare le informazioni in diversi formati ( ad esempio pagine stampate , schermi di computer e schermi del telefono cellulare ) si consiglia di utilizzare un framework "single sourcing" , come XML e DITA . Questi strumenti consentono di separare le informazioni dal formato in modo le informazioni possono essere " riproposto " più facilmente . Se si decide di " fonte unica " le tue informazioni , piano per esso , come all'inizio del processo il più possibile . Si producono blocchi di informazioni ( " temi " ) e molteplici formati di distribuzione , che richiede più layout grafici .
4

Creare un layout in un programma di progettazione pagina, come FrameMaker ( per i progetti di testo - pesanti il cui formato non cambia molto da una pagina all'altra ) o InDesign ( per i progetti di grafica pesanti , o manuali in cui il visual design di base varia da una pagina all'altra ) .