Dokumentationens hvem, hvorfor og hvornår

Hvornår du end ønsker at fortælle noget til nogen, for eksempel når du overvejer at begynde på at skrive dokumentation – start med at overveje, hvorfor du vil gøre det?

Hvem vil høre eller læse det, og hvornår sker det – hvilke situationer er de i, når de gør det?

Ethvert spørgsmål har sit eget svar

Du vil hurtigt kunne samle en liste sammen over forskellige behov – forskellige spørgsmål, der skal besvares af dokumentationen:

  • Hvad er det her for et produkt – hvad kan det? Dette spørgsmål opstår måske inden kunden har købt produktet, eller måske er en medarbejder blevet bedt om at begynde at bruge produktet og vil derfor gerne vide, hvad det egentligt gør.
  • Hvilke krav stiller produktet? Før det tages i brug, er det måske nødvendigt at installere det – hvilket kræver, at en eller anden for for installationsmiljø bliver etableret. Og det har måske også nogle løbende krav, såsom at en medarbejder overvåger det, eller at brændstof bliver fyldt på.
  • Hvordan skal produktet vedligeholdes? Har det brug for smøring, softwareopdateringer, løbende forsyning af sliddele og forbrugsstoffer?
  • Hvordan er det tænkt, at processen for at anvende dette produkt skal se ud? Ganske ofte har et produkt sine egne behov for, at ting bliver gjort i en bestemt rækkefølge – også selv om brugen af produktet samtidigt skal passe ind i et generelt arbejds-flow.
  • Hvordan kommer jeg i gang? Eftersom et nyt produkt kan virke overvældende, når man ser det første gang, er det ofte nødvendigt, eller i det mindste påskønnet!, med nogle retningslinjer for, hvordan man skal starte med at bruge det.
  • Hvordan udfører jeg denne eller hin specifikke opgave? Det er ofte nødvendigt at have en use case-orienteret tilgang til manualer og guidelines – brugeren har simpelthen behov for at udføre en opgave så hurtigt som muligt men ved ikke præcist, hvad der skal gøres.
  • Hvad er der ellers i det – hvordan kan jeg få maksimalt udbytte af produktet? Yderligere reference- og bagggrundsinformation kan hjælpe brugere til at nå det punkt, hvor produktet ikke længere er en tidsforbrugende ekstra ting men, såmen, et middel til at spare tid og blive mere produktiv.

Der kan være andre spørgsmål, afhængigt af hvilket produkt vi taler om. Og ofte vil du overveje at skrive guidelines for, hvordan man gør noget, der involverer dette produkt men også andre produkter og generelle arbejdsopgaver. Dette kan være ekstremt nyttigt for brugeren og gøre det muligt for dit produkt at nå et højere niveau af anerkendelse, da det ses som en brik i et puslespil af komplekst arbejde, som dermed bliver lettere at udføre.

Analyse

Du ved, hvad du vil have – en manual eller anden form for teknisk dokumentation. Ellers noget forretningsorienteret dokumentation, såsom en forretningsplan. Men hvorfor vil du have lige præcis dét? Og hvilken for skal det have? Hvor mange dokumenter – bare ét? Eller måske flere, hvert af dem målrettet et bestemt formål eller en bestemt gruppe af brugere?

Analyse betaler sig altid! Den gør det muligt for projektet eller aktiviteten at bevæge sig i en rigtig retning fra starten. Selvfølgeligt skal dette ikke forhindre nogen i at blive klogere undervejs og måske genoverveje, hvad der er brug for, eller beslutte sig for at tilføje noget mere. Derfor er analyse generelt ikke et éngangs-“komme igang”-fænomen. Det er en aktivitet, der finder sted parallelt med resten af aktiviteterne, hele vejen igennem.

Sommetider giver det mening at lave en separat analyserapport, inden man foretager sig andet. Den kan hjælpe til at træffe den bedste beslutning om, hvordan man skal gå videre, og den er ofte nødvendig for jeres interne processer omkring dette. Andre gange bør analysen snarere fokusere på en række af møder, måske arrangeret i en eller anden type formelt setup, så som agilt, der gør det muligt for interessenterne at holde sig orienteret undervejs og også muligt at ændre kursen.

Selv de mindste opgaver har normalt gavn af en eller anden form for analyse – måske blot et kort møde, der kan introducere deltagerne til opgaven, hvorved de finder ud af, om noget behøver at blive afklaret.

Forskellige typer dokumenter

Vi kunne nemt nævne en fantasilion forskellige slags dokumenter og andre faconer af og tilgange til dokumentation, men i stedet vil vi nøjes med at påpege, at måderne, dokumentationen kan arrangeres på, er næsten uendeligt mange. Den traditionelle trykte manual eller installationsvejledning står måske stadig stærkt, men diverse yderligere og anderledes traditioner er dukket op – ikke mindst sådan noget som vejledninger i opgradering af software eller bortskaffelse af produktet, når det en dag er blevet til affald, som ikke var nødvendige for få år siden men i dag kræves af kunderne eller loven.

Tænk kreativt omkring dette – hvilken information er nødvendig for en kunde, en bruger, en genbrugsstation osv. – lige nu, når produktet først tages i brug, under normal brug, ved slutningen af produktets levetid – og senere?

Overvej også, hvem brugerne af informationen er, og hvilke baggrunde og viden, de kan have. Definer eventuelt en skillelinje for den forventede viden hos disse brugere, for at undgå at forsøge at dokumentere hele verden om og om igen. Og overvej en lagdelt dokumentation, hvor hver bruger kan springe ind på det lag, der svarer til vedkommendes individuelle viden, kompetencer og behov.

Og undervejs i denne proces, tænk over, hvor denne information kan findes i dag. Eksisterer den allerede et eller andet sted, så de påtænkte brugere blot skal peges i den rrigtige retning? Er den baseret på intern viden, som måske ikke i dag er tilgængelig i nogen form og måske vil kræve en analyse af selve produktet – eller er den tilgængelig og behøver blot at blive beskrevet på en brugervenlig måde?

Noget dokumentation handler måske nok om produktet men uden at beskrive dets tekniske konstruktion eller dets anvendelse – dette kunne være juridiske emner eller miljøinformation, og givetvis meget mere, og denne information er måske tilgængelig fra forskellige kilder, så det bør overvejes i hvilket omfang disse er tilgængelige.

Forskellige medier

Papirdokument

The Software Craftsman bookStatistical Analysis bookpixelPCB Currents bookSelv om det papirløse kontor blev annonceret for mange år siden, er vi stadig afhængige af tryksager. En nylig spørgeskemaundersøgelse i Sverige afslørede, at de fleste mennesker stadig foretrækker at læse bøger på papir. Der er er forskelle i forhold til alder, men alle aldre har deres store andel af mennesker, der foretrækker papirbøger.

Når man ser på det særlige tilfælde dokumentation, bruges bogen nok ikke helt på samme måde som fx en roman – den læses ikke fra ende til anden, læses ikke på de samme steder som romanen, såsom i flyveren, på toget eller i sengen. Men ofte ønsker man at have bogen liggende åben ved siden af sig med sine beskrivelser af de aktiviteter, man måske udfører på sin computer eller på den vaskemaskine, man er ved at installere. Eller man bruger bogen under en uddannelse, hvor man bærer den med sig omkring, laver noter i den, låner den ud til andre…

Kortere papirværker omfatter et produktark, der kan deles ud på messer og lignende, brochurer, der kan stables op i receptionen til inspiration for gæsterne, og plakater, der kan hænge på væggen med overblik og instruktioner. Og der er mange flere.

Vi skal ikke trykke alting, bare fordi det er muligt, men ofte har det sine fordele for nogle mennesker i nogle situationer, og så bør det overvejes. Når man designer et dokument, er det derfor en god idé at designe det til at se godt ud på tryk.

Elektronisk dokument

Volatile MarketspixelBrand Revitalization bookpixelFoundations of Green IT bookForuden simpelthen at være en fil, der indeholder det samme dokument som vi også har på tryk, giver det elektroniske format mulighed for mange former og konstruktioner. Ikke mindst kan det indeholde hyperlinks – til andre steder i det samme dokument eller videre ud til andre dokumenter eller endda websites eller applikationer. Fra et elektronisk dokument kan du faktisk udføre arbejdet; det bliver et aktivt dokument.

Visse filformater er meget populære, og pdf er det allermest brugte til elektroniske dokumenter. Det giver mulighed for diverse smarte detaljer og funktioner såsom at lave noter, signere, vise en oversigt over indholdet osv., eller det kan simpelthen printes ud (hvilket faktisk er pdf-formatets oprindelse – en postscript-fil, der kan printes). Word-formater, nye og gamle, er også populære, og det samme er såvel Excel-filer og PowerPoint. Diverse lignende formater anvendes af konkurrenter til Microsoft Office, men ofte bliver folk forvirrede, når man distribuerer filer i disse formater, så hvis det ikke skal være pdf, så bør man ofte starte med at overveje enten Word-, Excel- eller PowerPoint-filtyperne.

De elektroniske dokumenter har den enorme fordel, at de kan opdateres når som helst og gøres tilgængelige for download – dette forenkler distributionsprocessen, sammenlignet med den for papirdokumenter. Desuden kan man distribuere dokumentations-filerne sammen med software-filerne, hvis man ønsker dette.

Website

Som en platform for indsamling og deling af information i fri form, kan et almindeligt website være passende. Det kan være dedikeret til formålet eller simpelthen blot være en side på virksomhedens eksisterende website.

Vidensdatabase

for at kunne håndtere et stor antal individuelle beskrivelser, som i et leksikon, og tilføje de søge- og link-funktioner som computere er supergode til, vil et vidensdatabase-system af en eller anden art ofte være passende. En velkendt form er wikien. Alle kender Wikipedia, men der er faktisk nemt at lave i lignende system til et specifikt formål, enten til internt brug i virksomheden eller til at dele, for eksempel, dokumentation med kunderne.

Vi har lavet en eksempel-wiki:

Inidox Documentation Wiki

Andre angrebsvinkler

Foruden at udgive dokumenter i den ene eller den anden form på det ene eller det andet medium, findes der også andre måder, hvorpå man kan formidle den samme nye viden og løbende support til brugerne. Disse måder er bestemt ikke nye, men at tænke dem ind i en dokumentations-strategi kan være nyt og banebrydende for nogle. Ikke desto mindre kan det passe ind i situationen og vil derfor være et nyttigt element i den samlede løsning.

Kurser

Du kan fortælle brugeren af et produkt, hvordan det skal bruges, via en manual, men du kan også demonstrere det og samtidigt give baggrundsinformation og vise relaterede produkter og hvordan det hele arbejder sammen.

Et godt gammeldags kursus er normal vejen frem, når mange tråde af information skal væves sammen til et tæppe af kompetencer og viden, og det kan arrangeres mere eller mindre som en workshop for at give praktisk hands-on erfaring med produktet.

Seminarer og webinarer

Sammenlignet med et kursus er et seminar (eller webinar, hvis det meget bekvemt tillader deltagelse via en browser eller lignende) som regel af en mere forklarende natur og mindre hands-on. Og ofte fortælles der mere om, hvad produktet er for noget og hvilke funktioner, det har, snarere end hvordan disse præcist skal anvendes.

Ikke desto mindre er skillelinjen mellem disse tilgange lidt uskarp.

Online videoer

Kurser, seminarer og webinarer kan optages og tilbudt som online-videoer, men man kan også lave dedikerede videoer, der forklarer en specifik detalje om produktet eller dets anvendelse, uden at forsøge at favne om hele produktet.Disse små videoer er blevet massivt populære over de senere år, ikke mindst gennem services som YouTube, der gør videoerne let tilgængelige for enhver.

Videoer behøver naturligvis ikke at være tilgængelige online men kan også leveres på en DVD eller andet, men hvis produktet har mange brugere spredt over hele kloden, så bør man i det mindste overveje om videoer i en eller anden form kunne hjælpe dem til at bruge produktet bedre.

Teknisk support

Det er ikke usædvanligt i dag at levere produkter helt uden nogen form for trykt dokumentation eller måske blot med en kortfattet “komme igang”-vejledning, og så tilbyde en support-funktion via e-mail, telefon eller web-formularer. På denne måde bliver den tekniske support den primære kilde til information for mange brugere, suppleret af uofficiel supportinformation fra andre brugere i form af bøger, web-fora eller hvad man ellers kan forestille sig.

Uanset hvad der ellers leveres til brugerne bør man overveje, hvordan en sådan support-funktion kan supplere det.

Annoncer og reklamer

Annoncering ses ofte som et salgsværktøj – man kan ikke stole på teksten i reklamen, da den simpelthen kun er beregnet til at fange potentielle kunders opmærksomhed, ikek for at lære dem noget. Men det behøver ikke (kun) at være sådan, da praktisk information givet gennem reklamer faktisk kan demonstrere din vilje som producent til at møde kunderne, hvor de er, hjælpe dem med deres behov og inspirere dem til at få den bedste udnyttelse af dit produkt.

Dette kan hjælpe salget og på samme tid reducere belastningen af den tekniske support, samt i øvrigt reducere behovet for andre typer af dokumentation.

Inspiration fra andre: anmeldelser, snak med naboerne

Du kunne måske have lyst til aktivt at søge at få brugerne til at beskrive deres oplevelser med dit produkt på deres blogs eller overfor deres naboer, kolleger osv., måske gennem en eller anden form for belønning. Ganske mange brugere af tekniske produkter får hjælp fra nogen, de kender, snarere end fra en omfattende manual, en forvirrende FAQ, en frustreret teknisk supporter eller hvad de nu ellers forestiller sig af alternativer. Og brugere kan stole så meget mere på andre brugere, at de er villige til at bruge mere tid på at lytte til deres forklaringer, end de er villige til at bruge på dine egne dokumentations-produkter.

Brugergrupper, dedikerede tidsskrifter (hvis dit produkt har en tilstrækkelig stor base af brugere), nyhedsgrupper, fora og andre koncepter kan etableres med deltagelse af brugerne som dine partnere.

Det er værd at overveje, hvordan denne form for “crowd sourcing” af teknisk assistance kan etableres og vedligeholdes, og hvordan du kan deltage i den og bidrage med de rigtige dokumenter, videoer osv., der giver brugerne indtrykket af at være deltagere i et stort fællesskab omkring dit produkt.