Lag et dokumentasjonskort før du skriver
Samle prosjektnavn eller godkjent anonymisering, periode, bestilling og rolle. For hver planlagte påstand noterer du hvor underlaget finnes og hvem som kan bekrefte det. Mangler støtte, skal formuleringen endres eller fjernes fremfor å skjules bak ord som vellykket.
Et illustrativt nettoppdrag kan ha levert ny sidestruktur og redigeringsflyt. Det viser ikke at kundens salg økte. Det siste krever annen dokumentasjon og rimelig tolkning. Ikke skriv en ønsket forbedring om til et målt resultat.
Bygg rundt en faktisk beslutning
Velg en konkret vanskelighet: en tjeneste var vanskelig å forstå eller prosjektmateriale manglet orden. Beskriv hva teamet visste, hvilket alternativ som ble valgt og hvorfor. Leseren kan lære noe selv uten publiserbare tall.
Forklar grensene. Lagde dere designet, men ikke innholdet, eller en pilot uten utrulling? Skriv det. Ikke tilskriv dere hele bidraget fra andre leverandører, kunden eller et felles team.
| Påstand | Underlag å kontrollere |
|---|---|
| Vi utviklet ny struktur | Godkjent leveranse og faktisk ansvarsdeling |
| Besøkende fant lettere frem | Hvilken observasjon eller undersøkelse støtter det? |
| Resultatet økte | Definisjon, periode og grunnlag for sammenligning |
| Kunden sier | Godkjent sitat med riktig sammenheng |
Velg bilder som støtter forklaringen
Et før- og ettereksempel trenger sammenlignbare oppgaver. Forklar hva som endret seg og hvorfor. Et pent skjermbilde uten sammenheng kan fungere som portefølje, men er ikke automatisk dokumentasjon på bedre brukervennlighet.
Kontroller private opplysninger, fortrolige dokumenter og grensesnitt dere ikke kan publisere. Skill en konseptillustrasjon fra et virkelig prosjektfoto. Registrer fotograf og tillatelser i medieregisteret. At materialet ligger i en gammel mappe, viser ikke at det kan publiseres på nytt.
La riktige personer granske hele siden
Send hele presentasjonen til faktagranskning, inkludert overskrift, bildetekster og metadata. Et korrekt avsnitt kan bli misvisende under en overdrevet overskrift. Bruk en intern godkjenningsliste fremfor å overlate tillatelser til skribentens antakelse.
Behold gransket versjon og beslutninger sammen med materialet. Kan en påstand ikke godkjennes, kan en mer avgrenset eller anonymisert beskrivelse være mulig etter avtale. Ikke finn på et annet kundenavn eller et fiktivt sitat og fremstill det som ekte.
Planlegg hvordan eksempelet holdes oppdatert
Utpek ansvarlig for endret prosjektstatus, lenker og publiseringsvilkår. En planlagt lansering kan senere være gjennomført, men det må bekreftes før teksten endres. Et eldre eksempel trenger ikke være feil; det trenger tydelig sammenheng.
Lenk til tjenesten som faktisk hører sammen med bidraget og nyttige forklarende guider. Målet er at leseren kan vurdere neste steg med rimelige forventninger. En prosjektpresentasjon garanterer ikke samme utfall for en annen kunde.