Tips om å lage online hjelp

  Hjelp manuskripter er ikke fulle håndbøker, men er hurtigstudier for å feilsøke feil og problemer som oppstår med programvare, maskinvare eller andre produkter. Opprettelse av online hjelp kan virke som en skremmende oppgave, men arbeidet er enkelt hvis du bruker noen grunnleggende tips og standardkonvensjoner for forretningsskrifter til dokumentene dine.

Serienummer

Inkluder spesifikk informasjon om produktet, slik som som navn og serienummer, på den første siden av onlinehjelpen.

Innhold

Inkluder innholdsfortegnelsen for onlinehjelpen. Dette kan enten være et hyperkoblet dokument i HTML-skjema eller gitt i en PDF-, Dok- eller tekstform. Uansett hvilket format du velger, trenger du en måte for leseren å navigere i hjelpedokumentet.

Format

Bruk kortfattede forklaringer. Wordy manuskripter roter online hjelp og gjør det vanskelig for leseren å forstå eller finne løsningen på dine spørsmål. Online hjelp er ikke en reklame for produktet, men en teknisk referanse for de som søker svar på uventede problemer. Vær sikker på å legge ut trinnene for å løse problemet i et lettlest omrissformat, helst med punktpunkter for å veilede leseren.

Proofread

Har en profesjonell redaktør korrekturlest for grammatikk, stavemåte og tekstflow . Kjøperne av produktet ditt vil ikke vurdere din bedrift legitimt hvis hjelpedokumentasjonen har grammatikk og stavefeil eller er vanskelig å lese eller forstå.

Faktokontroll

Fakta sjekk all hjelp før du laster opp den til nettstedet ditt. Rediger manuskriptet for feil og utelatelser om produktet. Oppgi et telefonnummer, adresse eller e-post for spørsmål om eventuelle problemer som kjøperne kan legge merke til i teksten. Sørg for at du har en person eller personer dedikert til oppgaven med å svare på disse spørsmålene. Oppgi antall timer med kundesupport i manuskriptet.

Diagrammer og bilder

Inkluder alle nødvendige bilder og diagrammer for produktet eller programvaren. Sørg for å merke etikettene tydelig i forhold til teksten. Vær sikker på at de medfølgende fotografiene er i fokus og i nærheten av deres relevante innhold.

Manusformater

Tilbyr hjelp i enkle å laste ned formater, for eksempel PDF eller Doc. Enkel tekst anbefales kun som manuskriptformat hvis hjelpen din ikke har diagrammer eller grafikk. Sørg for at du har koblinger til nettsteder, for eksempel hvor kunden kan laste ned en PDF-leser, for eksempel.

Andre språk

Tilbyr din online hjelp på andre språk. Flerspråklig hjelp er nødvendig hvis du er en forhandler som selger et produkt til et internasjonalt publikum. Ikke stole på maskin- eller programvareoversettelser for oversettelsen, men ansett morsmål for å oversette og redigere dokumentasjonen. Dårlig oversatt hjelpedokumenter vil miste kunder og begrense evnen til å selge på internasjonale markeder.