Är inte Word gammalmodigt?

Skriva teknisk dokumentation i Word

Är inte Word helt ute som manualformat?

Det finns många avancerade verktyg för teknisk dokumentation. De flesta är xml-baserade som underlättar för single-sourcing, översättning och kanske continuous delivery. Just nu är Docs like code i ropet (kom på meetup!), vilket också kräver en viss typ av plattform för att fungera.
Är det då inte helt otidsenligt att prata om att skriva en manual i Word?

Word är lättillgängligt

Självklart är en Wordmanual inte någon spjutspets inom teknikinformation. Men det går ju inte att förneka att Word, Open Office och Google docs fortfarande är verktyg som ligger nära till hands om du nu kanske inte är teknikinformatör till yrket eller om du lite snabbt vill skriva ner lite tankar och dela med andra.

Jag använder själv Word varje dag.

Verktyget skapar inte strukturen – det gör du

Eftersom principerna för bra teknikinformation faktiskt inte hänger på verktyget i första hand så tycker jag att det duger bra för att träna upp dina skills inom manualskrivande.

Jag upplever också att många gärna vill kunna skriva ut manualer och lathundar på papper. En del vill till och kludda lite på utskriften med en PENNA! Ja, jag vet.

Digitalisering gör många saker både bättre och enklare, men ibland behöver vi ta små steg i taget. Jag skriver ofta mina utkast för hand, med vanlig penna på papper. (Det här är min favoritpenna – suddbar!) 

Pennan har ju inte utrotats bara för att vi har skaffat elektroniska verktyg. Inte heller tycker jag att det är dags att skippa vanliga texteditorer bara för att finns mer avancerade verktyg där ute.

Lär dig metoden först

För de allra flesta ligger en vanlig texteditor som Word eller Google docs närmast till hands att använda när det är dags att skriva något på dator. Att både lära sig ny programvara och ny metod för att skriva teknisk dokumentation kan lätt bli överväldigande.

Så ta ett steg i taget. Lär dig hur du kan strukturera och utforma en användbar manual i Word med hjälp av en bra skrivmetod. Därefter kanske du känner att du vill kunna lyfta informationen ett snäpp eller två. Tagga med metadata. Återanvända textbitar på flera ställen. Publicera som html. Då är det dags att gå vidare till mer avancerade verktyg.

Mer hjälp?

Om du vill lära dig en metod för att skriva manual så gå gärna min webbkurs. Läs mer om min webbkurs här. 

Om vill ta hjälp av en manualmall i Word så kan du ladda ner min mall här.

Du kan sedan titta på videon här nedan om du vill få hjälp med att anpassa färgerna i manualmallen till din egen grafiska profil.

Dela på facebook
Dela på twitter
Dela på linkedin
Dela på email

Jag hjälper dig med metoder, kunskap och erfarenheter kring produktdokumentation så att den blir både effektiv och användbar.

Fler inlägg

Buffe med mat

Därför ska du skriva manualen som en buffé

Jag är en förespråkare av modulär teknisk dokumentation. Varför? För att det gör dokumentationen lättare att använda, lättare att skriva och framför allt lättare att uppdatera. Hur då? Modulärt julbord

Instruktioner för att laga soppa

User stories ger dig rätt instruktioner (del 2)

User stories visar vad er produkt faktiskt ska uträtta åt användaren. Eller snarare vad användaren vill göra. Du kan nu enkelt förstå vilka instruktioner som du behöver skriva. Välkommen till

Läsare av teknisk dokumentation

Fixa dokumentationen med user stories (del 1)

User stories kan ge dig en flygande start när du ska skriva teknisk dokumentation, särskilt manualer av olika slag. Det gäller oavsett om det är grundläggande manualer till slutanvändare, integrationsinstruktioner

Musfälla

Trick för att locka information ur utvecklare

Att få fram underlag till teknisk dokumentation är verkligen en utmaning. Själv har jag provat allt. Jag har mutat utvecklare med kakor. Intervjuat stressade projektledare. Filtrerat ofantliga mängder med utvecklingsärenden

Tips till dig som skriver lathund i affekt

Behöver dina kunder en lathund för er produkt? Eller behöver ni själva en intern lathund på kontoret för att komma tillrätta med reseräkningarna? Lathundar kan vara många olika saker. Allt

Gunilla Svanfeldt Omslag

Samtycke till marknadsföring

Vi lagrar informationen som du anger i formuläret för att kunna kontakta dig med nyhetsbrev, om uppdateringar och med erbjudanden. 

Markera kryssrutan i formuläret för att ge ditt samtycke till att vi skickar e-post till dig.

We use MailerLite as our marketing automation platform. By clicking below to submit this form, you acknowledge that the information you provide will be transferred to MailerLite for processing in accordance with their Privacy Policy and Terms of Service.