Vad är det bästa sättet att skapa användarmanualer?

Användarmanualer vägleder montering, installation och användning av en produkt. Användarmanualer kan vara i olika former, såsom användarinstruktioner, användarguider, snabbstartsguider, kom igång-guider eller teknisk dokumentation.

Vem är inblandad i tekniskt skrivande, och hur går det till?

Det finns vanligtvis tre sätt som företag producerar teknisk skrift , inklusive användar- och bruksanvisningar. Låt oss se vilket tillvägagångssätt som är bäst och hur du kan göra det bästa av varje metod.

1. Be den tekniska personalen att skriva bruksanvisningen

Många företag tenderar att tilldela en eller ett team av tekniska personer att göra skrivjobbet. Det kanske låter som en smart idé.

Detta team inkluderar produktingenjörer, utvecklare och designers. De är fäderna, skaparna. Så de vet allt (om inte var och en individuellt, men kanske helt och hållet). Med ett ord, de är ämnesexperter. Och om det finns en bugg eller ett fel är de också den bästa referensen.

När allt kommer omkring, varför bry sig om att rekrytera och betala en extra anställd när de bästa resurserna bara finns där? Detta är inte den bästa idén och inte heller den mest ekonomiska. Även om den tekniska personalen är en av referenserna för en manual, är de inte nödvändigtvis de bästa personerna för att skapa en utbildningsmanual. Här är varför:

För det första, är de bra författare? Många tekniker vars främsta jobb är att designa och utveckla en produkt är inte intresserade av att skriva och dokumentera; av samma anledning har de inte ägnat sig åt att skriva professionellt. De kanske tror att de har andra brådskande saker att göra, vilket är sant, med tanke på deras primära uppgifter och ansvar. Därför kanske de inte är skickliga författare och är ovilliga att skaffa sig dessa färdigheter. Men om dina tekniska personer är bra skribenter eller är intresserade av att skriva, har du tur. Ändå är det inte allt.

För det andra, personer som är involverade i den tekniska utvecklingen av en produkt har olika syn på den. De är benägna att anta mycket uppenbar information, medan en förstagångsanvändare verkligen behöver förtydliganden. De kommer sannolikt att hamna i den här tekniska skrivfällan och ge detaljerad teknisk information som de tror är viktig men inte till hjälp för en användare.

Vissa detaljer är avgörande för ingenjörer men hjälper inte genomsnittliga användare. Det som är viktigt för användarna är resultatet av den tekniska processen och hur den möter deras behov, inte vad som ligger bakom processen.

Manualer måste vara kortfattade och reserverade i tekniska detaljer samtidigt som de ger generösa instruktioner och varningar. Ämnesexperter använder sannolikt också tekniska ord och jargong och tycker att det är OK. De kan till och med förklara terminologin genom att hänvisa till andra ordförråd, vilket skapar förvirring.

Tips för att få den här metoden att fungera:

Om du vill be din nuvarande tekniska personal att skriva manualen, involvera hela teamet. På så sätt kan du se till att olika perspektiv tillämpas.

2. Be den tekniska personalen att skriva manualen och låta en redaktör/skribent korrekturläsa den.

Så här går det till. Tekniska personer skriver ett utkast och lämnar det till en redaktör/teknisk skribent. På så sätt är det mer sannolikt att skrivstandarderna uppfylls. Författaren kommer att förenkla vissa delar, ersätta jargong med vanligare ord, förena hela stilen, tillämpa några knep och göra den mer attraktiv.

Denna metod låter mycket bättre. Men kan man se till att redaktionen fyller de luckor som den tekniska personalen har skapat i första hand? De kan nog inte gissa alla delar som saknas och förbättra det de har fått.

Tips för att få ut det mesta av denna metod:

• Ett bra samarbete skulle kunna resultera i att skapa en professionell. Se till att du kopplar ämnesexperterna (ditt tekniska team) till skribenten/redaktören och be inte bara slumpmässiga skribenter att redigera ett dokument utan bakgrundsinformation.
• Se till att skribenten ofta kan komma tillbaka till det tekniska teamet för att diskutera olika delar eller när det finns en fråga. Låt även det tekniska teamet granska det redigerade dokumentet för att säkerställa att tekniskt innehåll har uppfattats och kommunicerats korrekt.

3. Låt en teknisk skribent göra jobbet i nära samarbete med det tekniska teamet

Att anlita en teknisk skribent låter som den perfekta metoden. Att ha en teknisk skribent som skapar manualen från första början samtidigt som den har möjlighet att samarbeta nära med det tekniska teamet, använda, testa och studera produkten är den saknade ingrediensen i en perfekt utformad användarmanual. Det rekommenderas starkt att du rekryterar en teknisk skribent för att skriva manualen. Ämnesexperter kan granska, kommentera, förklara och redigera samtidigt som de diskuterar produktens funktioner och egenskaper.

Samarbetsskrivande är det magiska tricket.

I alla tre tillvägagångssätten är samarbete nyckeln till ett bättre utformat skrivande. Dokumentationsverktyg som fokuserar på lagarbete och ger ett utrymme för effektivt samarbete skulle kunna underlätta denna process. Många onlineverktyg försöker göra det enklare. Det finns mycket mer för att öka samarbetet än bara förmågan att dela, kommentera och diskutera olika delar.

Sonat har börjat fokusera mer och mer på att främja kollaborativt skrivande genom att förbättra arbetsflödesfunktioner där du kan definiera en automatiserad process. I denna process. Alla i en organisation kan vara involverade och det är möjligt att tilldela olika uppgifter och åtkomstnivåer samtidigt som man tillämpar automatiska regler; som ett resultat sparar det mycket redigeringstid.

Med Sonat kan du förhindra publicering av lågkvalitativa och oövervakade dokument samtidigt som du sparar mycket tid för dina redaktörer och experter.

Läs mer om Sonats samarbetsfunktioner här .