Com escriure un manual (amb imatges)

Taula de continguts:

Com escriure un manual (amb imatges)
Com escriure un manual (amb imatges)

Vídeo: Com escriure un manual (amb imatges)

Vídeo: Com escriure un manual (amb imatges)
Vídeo: Запись в файл на iMacros 2024, Març
Anonim

Escriure un manual d’instruccions pot semblar una tasca descoratjadora, però és més fàcil del que es pensa! Aquests passos s'apliquen a qualsevol instrucció escrita, des de la molt senzilla (Com aplaudir) fins a la molt complicada (Com construir un semiconductor).

Passos

Primera part de 4: Coneix el tema

Escriviu un pas manual 1
Escriviu un pas manual 1

Pas 1. Això és clau

Pot semblar evident, però el coneixement és la clau per escriure un manual amb èxit. Per exemple, si escriviu un manual de càmera, saber que un paràmetre f i la velocitat de l'obturador no són només dues funcions diferents, sinó que, però saber com interactuen entre ells us facilitarà la descripció de cadascuna funció en relació amb el conjunt.

Escriviu un pas manual 2
Escriviu un pas manual 2

Pas 2. Parleu amb experts

Si el vostre paper és simplement l’escriptor més que l’expert en la matèria, involucreu persones coneixedores durant tot el procés i assegureu-vos que revisin la vostra obra. El seu coneixement i consell és inestimable.

Escriviu un pas manual 3
Escriviu un pas manual 3

Pas 3. Proveu un enfocament pràctic

Si és possible, fer allò que escriviu us donarà, com a mínim, una idea del que l’usuari voldrà aprendre.

Escriviu un pas manual 4
Escriviu un pas manual 4

Pas 4. Llegiu el tema

Apreneu a parlar-ne i familiaritzeu-vos amb el producte sobre el qual escriviu.

  • Els manuals de productes similars us mostraran com altres escriptors han tractat el tema.

    • Cerqueu similituds entre els escriptors, que indiquin una funcionalitat comuna i enfocaments comuns per descriure alguna cosa.
    • Busqueu diferències que destaquin. És probable que siguin funcions exclusives d’un producte determinat. El vostre producte pot incloure o no aquestes funcions o pot tenir formes alternatives de resoldre el problema que podeu descriure, millorant el valor del vostre producte. Tot i que és possible que el vostre treball estigui escrivint instruccions, mostrar als clients el valor de la seva compra és una bona manera d’animar-los a continuar llegint.
  • Devora revistes comercials. Esbrineu com treballen el dia a dia les persones que fan servir els productes. És possible que desitgin que hi hagi una funció que resolgui el seu problema particular i, si el vostre producte és la solució, cal ressaltar-la.

Part 2 de 4: planifiqueu el disseny manual

Escriviu un pas manual 5
Escriviu un pas manual 5

Pas 1. Desglosseu-lo

Ja sigui un simple full d’instruccions pas a pas o un manual per a una càmera digital de 35 mm, dividir-lo en trossos digestibles té diversos avantatges:

Us permet centrar-vos en parts individuals del conjunt. El vostre objectiu és familiaritzar l'usuari amb com aprendre el procés. La manera de realitzar la funció es pot deixar en un tutorial al final, si es vol, o deixar-la perquè l'usuari la descobreixi sola

Escriviu un pas manual 6
Escriviu un pas manual 6

Pas 2. Seguiu una seqüència lògica

No serviria de res, per exemple, descriure com funciona el flaix d’una càmera fins que no mostreu com fixar l’objectiu, carregar la pel·lícula, encendre la càmera i ajustar el focus. Això és especialment útil si no coneixeu bé el tema.

Escriviu un pas manual 7
Escriviu un pas manual 7

Pas 3. Utilitzeu aquesta com a plantilla per a la vostra taula de continguts

Escriviu un pas manual 8
Escriviu un pas manual 8

Pas 4. Reviseu els vostres passos

Un cop definides les seccions lògiques, reviseu-les per assegurar-vos que tot està cobert.

Escriviu un pas manual 9
Escriviu un pas manual 9

Pas 5. Recolliu els vostres subministraments

Teniu a mà els elements que descriviu i a punt per utilitzar-los, tal com es descriu al manual. Si feu una caixa de paper, tingueu a mà paper, tisores, cinta adhesiva, cola i una regla. Si escriviu sobre una càmera, assegureu-vos que la càmera estigui desmuntada. Si és possible, el producte sobre el qual escriviu hauria de tornar a estar al quadre en aquest moment.

Part 3 de 4: Comenceu a escriure

Escriviu un pas manual 10
Escriviu un pas manual 10

Pas 1. Escriviu la introducció

Això definirà el to de tot el manual i donarà a l’usuari una idea sobre quin tipus de manual està a punt de digerir. Serà lleuger i divertit, o senzill i sense tonteries? Depèn dels vostres lectors. Hi ha molt més espai per als jocs verbals que ensenyen als nens a fer una caixa de paper que els que s’ensenyen al metge a procedir amb la cirurgia a cor obert. Establir el to aviat i mantenir aquest to durant tot el manual.

Escriviu un pas manual 11
Escriviu un pas manual 11

Pas 2. Realitzeu cada pas mentre escriviu

Això no només dóna als vostres escrits un aire d’honestedat i autenticitat, sinó que també assegureu-vos que res no quedarà al marge.

Si, per alguna raó, no és factible fer els passos, penseu-los a fons i consulteu algú expert

Escriviu un pas manual 12
Escriviu un pas manual 12

Pas 3. Numereu els passos

Això fa que la gent pugui seguir-lo més fàcilment i referir-s’hi en cas de perdre el lloc.

Si escriviu en paper, assegureu-vos de deixar espai per a les addicions entre cada pas. Recordeu que heu de tornar a numerar els passos si n'afegiu més

Escriviu un pas manual 13
Escriviu un pas manual 13

Pas 4. Incloeu consells i advertències

Mentre escriviu, us adonareu que si l’usuari realitza un pas sense tenir en compte, pot provocar un problema.

Per contra, si hi ha una mica de coneixement que farà que la tasca de l'usuari sigui més fàcil o més interessant, afegiu-la

Escriviu un pas manual 14
Escriviu un pas manual 14

Pas 5. Proveu-ho

Utilitzant només les vostres instruccions per escrit, feu el que escriviu. Si trobeu llocs on falten les vostres instruccions, afegiu la informació necessària. Repetiu aquest pas fins que tingueu tots els passos i pugueu fer el que esteu ensenyant sense haver d'afegir notes.

Penseu en la possibilitat que un amic o dos facin servir el manual. Mireu-los de prop quan aprenen a utilitzar el producte. Mireu per on la travessen. Vegeu on es perden, es confonen o fracassen en la tasca. Escolteu el que han de dir i, a continuació, ajusteu el manual en conseqüència

Escriviu un pas manual 15
Escriviu un pas manual 15

Pas 6. Reviseu el manual

No voleu enviar al vostre corrector de proves final (sigui l'agència o el cònjuge) un manual ple d'errors evidents.

Part 4 de 4: format

Escriviu un pas manual 16
Escriviu un pas manual 16

Pas 1. Comenceu al nivell superior

Un cop hàgiu detallat tots els passos necessaris, consulteu el manual per trobar els caps de categoria òbvies.

Anoteu-los i anoteu-ne les ubicacions

Escriviu un pas manual 17
Escriviu un pas manual 17

Pas 2. Escriviu una taula de continguts, si s’escau

Escriviu un pas manual 18
Escriviu un pas manual 18

Pas 3. Torneu a revisar

Sí, ja ho heu fet a fons una vegada. Fer-ho per segona vegada, sens dubte, detectarà alguns errors menors o llocs on el manual no està clar.

Per obtenir un manual més complet, també podeu aprofitar aquesta oportunitat per assenyalar tots els petits temes i utilitzar aquesta informació per crear un índex

Escriviu un pas manual 19
Escriviu un pas manual 19

Pas 4. Seleccioneu un títol

Consells

  • Encara que us sembli obvi, escriviu els passos. T’ajudarà a evitar la reflexió sobre allò que el teu usuari no coneix. És millor incloure informació addicional en lloc de deixar passos importants.
  • Si esteu escrivint un manual molt detallat que requereix capítols, com ara Com tocar la flauta, el vostre primer pas pot ser enumerar tots els capítols, com ara Selecció d’una flauta, Muntatge i cura, Producció de tons, Mètodes de digitació, First Piece, etc. A continuació, aplicaríeu les regles bàsiques per escriure un manual a cada capítol perquè cada capítol és com si fos un manual separat.
  • Sempre que sigui possible, il·lustreu les vostres instruccions. Si no podeu inserir imatges, consulteu l'estudiant a alguna cosa comú com a exemple. Per exemple, a Format, pas 2 d'aquestes instruccions, l'aspecte del disseny de wikiHow s'utilitza per il·lustrar com es podria crear una taula de continguts.
  • Escriure cada secció en una pàgina independent (o en un ordinador) facilitarà l’edició. Podeu reorganitzar-los més fàcilment si teniu espai per treballar i podeu trobar les vostres marques d’edició. A l’ordinador, deixeu 3 o 4 línies (prement entrar diverses vegades) entre cada pas perquè pugueu trobar fàcilment les pauses.
  • Si podeu, feu que un novell faci una prova del manual i escriviu totes les preguntes que us facin. Això us ajudarà a omplir els espais buits i a fer que el vostre manual sigui molt més útil.

Recomanat: