Sådan implementeres teknisk dokumentation

af ClickHelp - professionelt hjælpeforfineringsværktøj

Næsten ethvert produkt har en slags dokumentation, der skal bruges. Det kan være bare en advarsel eller korte brugsanvisninger. Og alligevel, selv da, er det meningen, at der er en person, der er tildelt til at skrive disse to linjer, og endnu vigtigere, at beslutte, hvad der endda skal skrives. For mere komplekse produkter skal der dog være en solid brugervejledning. Ellers vil din support sprænge af vrede opkald og beskeder fra utilfredse kunder. Men hvordan implementeres teknisk dokumentation fra bunden? I denne artikel vil vi give dig den generelle idé om implementeringsprocessen for dokumentation.

Mennesker

Hvis du ikke har nogen tekniske forfattere i staben, kan du gå to måder omkring det - ansætte fuldtidsspecialister eller kontrakt med nogen til deltidsarbejde. Det afhænger virkelig af arbejdsbyrden. For nogle virksomheder giver det mere mening at have en deltidsentreprenør til at udføre jobbet.

Hvis dit tekniske dokumentationsprojekt bliver temmelig stort og kræver konstant opdatering og vedligeholdelse, skal du virkelig overveje at have et eget dokumentationsteam. Naturligvis kræver denne tilgang meget tid og ressourcer, men i slutningen af ​​dagen har du et team af fagfolk, der kender dit produkt som deres hånd.

Behandle

På dette trin skal du dybest set gifte dig med dine tekniske og dokumentationsprocesser med hensyn til planlægning, tidsplaner og leverancer. Fra nu af skal tekniske forfattere inviteres til alle planlægningsdiskussioner og tekniske møder, da dokumentation skal være ajour. Med hver nye produktudgivelse skal der også være frigivelse fra dokumentationsteamet. At holde dokumentation opdateret kan være til stor hjælp, hvad angår sagsafbøjning og hvor succesfulde dine kunder har med produktet.

Format

Et brugervejledningsformat afhænger af den branche, du er i. Teknisk dokumentation kan sendes sammen med dit produkt som en trykt brugermanual eller på en cd, for eksempel. Overvej om muligt online dokumentationsformat. I dag har de fleste virksomheder gjort det til deres valg af format. Og der er mange grunde til dette. Først og fremmest - sådan dokumentation kan let søges i Google. Alle dine brugere har brug for er en browser og en internetforbindelse for at få svarene.

Webbaserede løsninger har meget at tilbyde. Når du får din online dokumentationsportal i gang, vil dit marketingteam øjeblikkeligt føle fordelene ved yderligere eksponering på nettet. Du kan omdanne din online brugervejledning til et kraftfuldt marketingværktøj ved hjælp af branding, nøgleord og søgbarhed.

Hvis du vil lære mere om fordelene ved din dokumentation, der offentliggøres online, kan du tjekke dette indlæg kaldet '18 milliarder grunde'.

Værktøj

Så snart du finder ud af dokumentationsformatet og samler teamet, er det tid til at kigge efter de rigtige værktøjer.

Heldigvis er der en masse klare løsninger derude, f.eks. HAT, eller hjælp til forfatterværktøjer. Dette er specielle værktøjer udviklet til tekniske forfattere, og de er så meget mere end bare software til tekstredigering. De fleste moderne løsninger til tekniske forfattere er meget fleksible, hvilket betyder, at du vil være i stand til at tilpasse værktøjet til dine specifikke behov.

Hjælp med redigeringsværktøjer som ClickHelp inkluderer funktioner til organisering af arbejdsgangen, som den fungerer for dig. For eksempel kan forskellige roller tildeles brugere, der er e-mail-meddelelser, emnestatus, gennemgang af processfunktionalitet og mere. Så du kan enten justere værktøjet eller opbygge en helt ny arbejdsproces omkring den funktionalitet, som din hjælpeforfatterløsning har at tilbyde.

Konklusion

Sådan implementeres teknisk dokumentation generelt. Naturligvis er hele denne proces meget mere kompleks i virkeligheden. I denne artikel har vi kun dækket nogle høje niveauer af implementering af brugervejledninger. Vi håber, at dette indlæg vil hjælpe dig med at se hele billedet, og derfra vil du være i stand til at gå videre til mere seriøse dybdegående ting og få succes med at organisere og vedtage hjælpeforfatterprocesser i din virksomhed.

Held og lykke med din tekniske karriere!
Klik på Hjælp-team
Forfatter, vært og leverer dokumentation på tværs af platforme og enheder

Oprindeligt offentliggjort på clickhelp.co.