Cum se face un manual de utilizare: 12 pași

Manualul utilizatorului este o cartelă de hârtie pe o suport de hârtie sau pe un suport digital (în format PDF sau XPS), în care instrucțiunile de utilizare a ceva sau descrie procedura corectă pentru efectuarea unui proces. Deși când o persoană aude expresia "manualul utilizatorului", De obicei, reprezintă un ghid pentru utilizarea unui program specific, instrucțiuni de utilizare pentru aparatele de calculator și de uz casnic (televizoare, sisteme stereo, telefoane, playere MP3, echipamente de grădină și t.D.). Un manual de utilizare bun indică despre funcțiile de bază ale dispozitivului sau ale programului și explică modul de utilizare corectă, iar informațiile sunt de obicei bine structurate. Acest articol va spune despre ceea ce este important de reținut la crearea și executarea manualului de utilizare.

Pași

Partea 1 din 3:

Crearea documentației

unu. Determinați cine cititorul dvs. Pentru a crea un manual de utilizare bun, trebuie să înțelegeți ce persoană va cumpăra dispozitivul la care creați instrucțiuni. Vă puteți înregistra gândurile, dar vă puteți imagina această persoană. Este util să faceți dacă lucrați ca o echipă pentru a crea documentație și dacă participați la dezvoltarea produselor de la început până la sfârșit. Gândiți-vă la următoarele:

În cazul în care o persoană va folosi manualul de instrucțiuni: acasă, la locul de muncă, în mașină, pe Internet? Acest lucru va determina nu numai conținutul, ci și stilul de documentare.
Ca persoană va folosi instrucțiunile? Dacă o persoană are nevoie doar ocazional în manualul de utilizare, înseamnă că instrucțiunea trebuie să fie încadrată într-o formă comprimată. Dacă manualul este adesea utilizat, în special la început, trebuie să includeți o întreagă secțiune privind modul de începere a produsului sau a produsului software și descrieți toate cele mai importante caracteristici.
Cât de multă experiență ar trebui să aibă o persoană? Dacă produsul dvs. este relativ nou sau semnificativ diferit de produse similare, va trebui să includeți informații despre modul în care acest produs diferă de analogi și să furnizați utilizatorului instrucțiuni detaliate. Dacă mărfurile sunt asociate cu probleme frecvente (de exemplu, cu un număr mare de programe), descrieți ce trebuie făcut atunci când apare problema.

Imagine intitulată Creați un manual de utilizare Pasul 2

2. Scrieți astfel încât cititorul să vă înțeleagă. Dacă numai produsul dvs. nu implică o cunoaștere îngustă a utilizatorului, este mai bine să se evite termenii tehnici și să descrieți totul simplu, ușor de înțeles. Structura textului trebuie să respecte secvența de întrebări care pot apărea de către utilizator. Este mai corect să grupați funcțiile dispozitivului în funcție de sarcinile pe care le efectuează și să abandoneze ideea de a uni într-un singur grup de funcții cele mai populare.

Uneori este imposibil să excludeți complet termenii tehnici (de exemplu, dacă efectuați instrucțiuni la programul de creare a graficelor și diagramelor, în cazul în care, pe lângă fondurile standard, sunt utilizate și instrumentele grafice Fibonacci). În acest caz, este util să se definească termenul și o scurtă descriere (adică ce este grafica Fibonacci și modul în care sunt utilizate în analiza indicatorilor financiari).

Imagine intitulată Creați un manual de utilizare Pasul 3

3. Descrieți problema cu care se poate întâmpina utilizatorul și apoi oferă o soluție. Când faceți publicitate un fel de produs, fraze despre cum poate rezolva o anumită problemă va atrage, fără îndoială, o mulțime de atenție. Dar când utilizatorul cumpără acest produs, el trebuie să explice ce să facă cu ea. Descrieți, cu ce probleme se poate întâmpla utilizatorul în timpul funcționării și include în instrucțiunile manuale pentru problemele în curs de desfășurare.

Dacă problema este complicată, rupeți-o în mai multe părți. Faceți o listă și însoțiți fiecare instrucțiuni de articol. Aceasta se numește blocuri.

Partea 2 din 3:

Piese compozite ale manualului utilizatorului

unu. Luați în considerare acoperirea și proiectarea primelor pagini ale secțiunilor. Va trebui să creați o acoperire dacă instrucțiunea durează mai multe pagini. De asemenea, va fi necesar să se plaseze paginile cu numele secțiunilor pentru instrucțiuni, unde cantitatea totală de informații durează mai mult de 4 pagini.

Dacă manualul de utilizare este protejat de drepturile de autor, indicatorul corespunzător trebuie să fie pe copertă și pe paginile de partiție.
Dacă manualul utilizatorului oferă anumite condiții pentru utilizarea produsului și a instrucțiunilor pentru acesta, plasați aceste informații din interiorul capacului.

Imagine intitulată Creați un manual de utilizare Pasul 5

2. Link-uri către un loc de documentare suplimentar în introducere. Dacă manualul constă din mai multe broșuri, specificați tot numărul de broșuri de la început. În plus, ar trebui să plaseze și o secțiune "Cum se utilizează acest manual de utilizare", Dacă decideți că o astfel de secțiune este necesară.

Imagine intitulată Creați un manual de utilizare Pasul 6

3. Dacă numărul de pagini depășește 10 bucăți, veți avea nevoie de un cuprins.

Imagine intitulată Creați un manual de utilizare Pasul 7

4. Baza manualului de instrucțiuni ar trebui să fie instrucțiuni și informații privind componentele mărfurilor. De regulă, instrucțiunile sunt rupte în blocuri, iar în fiecare bloc puteți specifica în ce secțiuni, utilizatorul ar trebui să caute acest lucru sau acele informații. Astfel încât utilizatorul va fi mai ușor și mai rapid pentru a găsi informațiile de care au nevoie.

Procesele ar trebui să fie descrise clar și consecvent. Începeți cu descrierea generală a sarcinii, apoi explicați că utilizatorul va trebui să facă și ce rezultat va trebui să obțină. Toți pașii trebuie să fie numerotați, iar propunerile ar trebui să înceapă cu verbele.

Materialele de referință ar trebui să includă o listă de funcții, metode de diagnosticare a defectelor și întrebări frecvente. La sfârșitul manualului utilizatorului, puteți plasa un scurt dicționar de termeni și indicatorul alfabetic, deși termenii principali sunt adesea făcuți la început. Pointerul alfabetic este recomandat pentru instrucțiuni al căror volum depășește 20 de pagini.

Imagine intitulată Creați un manual de utilizare Pasul 8

cinci. Utilizați imagini și scheme. Desenele și capturile de ecran pot descrie anumite procese mai bune decât textul, în special atunci când provine din procese complexe, unde trebuie să aveți o confirmare vizuală că persoana are totul corect. Imaginile grafice pot fi create în programe speciale: în sistemele de desen două și tridimensionale, în editori grafici, în aplicații de procesare a fotografiilor etc.D. Dacă trebuie să se facă capturi de ecran, acestea pot fi obținute utilizând personalul concurenței și programul grafic cu abilitatea de a salva capturile de ecran.

După ce obțineți o imagine grafică, salvați-o într-un format comprimat. De asemenea, este posibil să aveți nevoie să reduceți dimensiunea imaginii astfel încât să fie plasată pe pagină, dar dimensiunea nu ar trebui să fie prea mică, deoarece altfel, utilizatorul nu va putea să ia în considerare cum și ce ar trebui făcut. Dacă este necesar, puteți rupe imaginea în mai multe părți și descrieți fiecare dintre ele.

Dacă utilizați mai multe imagini, acestea trebuie să aibă aceeași dimensiune, proporție și rezoluție. Astfel de imagini vor fi mai ușor de înțeles și mai plăcut cititorului. Când creați capturi de ecran, asigurați-vă că utilizați schema de culori standard (pentru cazurile când manualul este imprimat în culoare).

Deși editorii grafici (de exemplu, Photoshop și Paint Shop Pro) sunt convenabili pentru a crea capturi de ecran, este mai bine să utilizați programe speciale (de exemplu, Snagit), deoarece le permit să fie imediat rapid și ușor de editat, salvați și semnați toate Imagini.

Partea 3 din 3:

Înregistrarea manualului

unu. Selectați font lizibil. Deși computerele suportă diferite fonturi, manualul utilizatorului trebuie să fie ușor de citit, deci da preferință cea mai simplă. Cel mai bine este să alegeți câteva fonturi care arată bine împreună. Există două tipuri de fonturi: cu serif și fără adidași.

Fonturile cu serif au linii mici de-a lungul marginilor liniilor. Astfel de fonturi includ Times New Roman, Baskerville și Carte Antichma. Astfel de fonturi vor corespunde unor volume mari de text imprimate cu 10 sau 12 dimensiuni și componente ale manualului de utilizare.
Fonturi fără adidași au linii simple fără decorațiuni. Acestea sunt fonturi cum ar fi goticul arial, calibri și secol. Fonturile fără serif sunt mai bine să se uite în texte imprimate cu 8 sau 10 fonturi în manualele PDF sau documentul web. Cu cât este mai mare fontul, cu atât este mai dificil să o citiți fără adidași. Cu toate acestea, aceste fonturi pot fi utilizate pentru textul mare - de exemplu, pentru un set de anteturi. Sourling Fonturile sunt potrivite pentru recrutarea cifrei în tabele și coloane.
Ar trebui să alegeți fonturi simple precum Arial sau Times New Roman, deși un font mai complex este potrivit pentru cotație. Dacă scrieți un manual de utilizare pentru un joc de fantezie, puteți evidenția cu titlul titlului orfelinatului. De asemenea, este permis să coase citatul italic.
După selectarea fonturilor, creați o pagină de testare pentru a vă asigura că aceste fonturi sunt combinate între ele pe hârtie. Afișați această pagină unei persoane care aprobă layout-uri înainte de a da manualului de utilizare pentru imprimare.

Imagine intitulată Creați un manual de utilizare Pasul 10

2. Gândiți-vă la schema de localizare a blocurilor de informații. În acest stadiu trebuie să decideți ce informații de comandă sunt plasate în.

De regulă, numele manualului utilizatorului și al numelor de capitol sunt plasate în partea de sus sau de jos a paginii împreună cu paginile de numerotare. Cifrele pot fi amplasate în exterior (pentru partea superioară și inferioară a paginii) sau în mijlocul (pentru Niza). Prima pagină a fiecărei secțiuni poate diferi de restul, astfel încât să puteți plasa numărul paginilor sale în mijlocul fundului și numerele tuturor celorlalte pagini - din exterior.

Fragmentele de text separate pot fi izolate după culoare, plasându-le în blocuri speciale. Este important să alegeți o astfel de umbră care nu ar înscrie textul.

Lăsați linii destul de mari din toate părțile. De la legarea liniei trebuie să fie mai largă.

Imagine intitulată Creați un manual de utilizare Pasul 11

3. Gândiți-vă la tipul de legare. Dacă există mai mult de 4 pagini în manualul dvs. de utilizare, veți avea nevoie de o legătură. Documentele pentru uz intern sunt de obicei fixate pe capsator în colț, dar dacă investiți ghidul dvs. la caseta cu o marfă, va trebui să abordați această problemă mai responsabilă. Există trei tipuri de legare:

Suportul de lipire. Acest tip este potrivit pentru broșuri cu dimensiuni 21x 27.5 cm, 21x35 cm sau 11 x 27.5x42.5 cm. Cele mai ieftine instrucțiuni de utilizare, care constau în 48 de pagini și mai puțin interconectate în acest fel.

Legarea VNAKIDKA. Deci, interconectați majoritatea instrucțiunilor obișnuite de utilizare, fără a număra instrucțiunile pentru autoturisme, deși unii lideri lungi sunt, de asemenea, interconectați în acest fel. Paint Shop Pro a fost furnizat inițial cu un astfel de manual de utilizare.)

Legarea cu spirala de sârmă. În acest mod, manualele care sunt utilizate în condiții mai severe sunt interconectate, de exemplu, pe stradă, unde capsele se pot rupe sau dispersa cu ușurință. În unele instrucțiuni de utilizare cu o astfel de legare, se găsesc și paginile laminate, care nu ud și nu murdăria în murdărie.

Imagine intitulată Creați un manual de utilizare Pasul 12

4. Luați documentul. Majoritatea editorilor și programelor de text pentru publicarea textului pe Internet există o oportunitate de aspect. Pe măsură ce tastați textul, acesta va fi afișat automat în fontul selectat. (Acest articol a fost inițial scris folosind un șablon în Microsoft Word.) Aceste programe au, de asemenea, șabloane gata făcute pe care le puteți modifica, luând în considerare nevoile dvs., în loc să creați un model de la zero.

În editorii de text și programele de publicare a textului pe Internet, există și o funcție de creare "stiluri", Salvarea fonturilor și a sarcinilor de locuri de muncă pentru tabele și subsoluri și textul de bază. Puteți alege din stilurile deja existente ("Titlul1", "Ca de obicei", "Citat") sau creați-vă propriul stil și dați-vă numele dvs. Este recomandat să apelați stiluri de-a lungul aceluiași sistem, așa cum este prevăzut în program. (De exemplu, Microsoft Word creează astfel de nume ca "Titlul1", "Titlul 2"- În plus, există încă subtitrări.) Configurați programul în avans, astfel încât să nu trebuie să vă întoarceți la acesta când veți scrie scrierea textului.

sfaturi

Dacă este posibil, utilizați coduri de câmpuri sau variabile de text. Puteți schimba valorile (de exemplu, numele produsului, numele capului manualului utilizatorului) și le puneți în document în locul în care de obicei vă deplasați la cuvintele manual. Când efectuați o previzualizare a documentului sau pregătiți-o pentru imprimare, textul dorit va fi introdus în variabile. Dacă numele schimbării mărfurilor sau dacă decideți să modificați numele capitolului, veți fi mai ușor să modificați textul prin înlocuirea valorii variabilei.

De ce ai nevoie

Editor de text sau program pentru publicarea textului pe Internet
Editor grafic sau program pentru crearea de capturi de ecran