Tag Archives: dokumentation

Manualer på svenska

När man sätter produkter på den svenska marknaden måste produkterna ha en svensk bruksanvisning om det inte är helt uppenbart hur produkten ska användas. Det betyder att de allra flesta produkter ska ha en svensk bruksanvisning.

rgb-styrenhet-colorwheel

Vi har importerat våra första produkter till EU och det är riktigt mycket jobb när man ska göra allt på rätt sätt. Just nu jobbar vi på med de svenska manualerna till produkterna. Först ut är en styrenhet till LED-strip med ett färghjul med touchfunktion som man kan styra precis vilken färg man vill att ljuset ska ha eller att välja bland något av de 18 inbyggda programmen.

För att skriva manualerna har valet fallit på det väldigt klassiska LaTeX-formatet då det blir väldigt prydligt och man kan hantera revisioner av dokumententen i ett vanligt källkodshanteringsverktyg så man kan hålla reda på alla utgåvor och vad som rimligen skickats ut till kunderna. Det lär ju bli några revisioner så här i början.

Varför väljer man en så ålderomlig teknik som LaTeX för att skriva manualer när det finns Microsoft Office och Word? Ja den frågan lär jag nog aldrig kunna svara på med ett rimligt svar som någon kommer tycka är ok. Jag gillar helt enkelt hur dokumenten ser ut samt spårbarheten i hur dokumentet sett ut i alla sina tidigare revisioner tack vare att det är ett textformat. Dessutom är det ett formatteringsspråk som jag använt i 20 år och hyggligt behärskar.

Något jag slås av när jag börjar med att skriva manualerna är att jag kollar på andra manualer. De känns ofta som om någon student fått i uppgift att översätta med t.ex. Google Translate, men när man väl sitter där med en massa text och underliga formuleringar där någon som inte har engelska som modersmål skrivit så är det verkligen inte lätt att få till det bra.

Kollar lite på mina leverantörers bruksanvisningar och ser att rätt många fuskar en hel del med manualer (och andra saker också för den delen som gäller när man har strikt produktansvar och ska följa Naturvårdsverket rekommendationer för märkning av produkter bara för att nämna några saker).