Hvordan kan du som produsent skrive til leseren?
Klarspråk (tone of voice) handler om å ta et produkts personlighet og uttrykke den gjennom måten man sier ting på. Hvis vi ser for oss produktet vårt som et verktøy som gjør oss i stand til å ha en samtale med brukerne våre, kan en nøye overveid tone i stemmen være avgjørende for hvordan brukerne opplever produktet.
Med fokus på DX (developer experience) ønsker vi at utviklere, produkteiere og andre brukere av plattformen skal kunne tilegne seg kunnskap effektivt uten å måtte lese mellom linjene for å oppfatte det som blir fortalt.
Ha fokus på målgruppen når du skriver
Klarspråk vil si kommunikasjon med så tydelig ordlyd, struktur og visuell utforming at leserne i målgruppen finner informasjonen de trenger, forstår den og kan bruke den.
Men hvem er egentlig leserne i målgruppen? Kort fortalt består utviklerportalens lesere av utviklerne som tar i bruk APIer og prosjektledere eller produkteiere (APOer) som publiserer innhold som omhandler APIene. Ved å sitte med et inntrykk av hvem de som leserne av utviklerportalen faktisk er kan det være lettere å uttrykke seg på en måte som gjør det lettere for mottakerne å forstå dem:
Utviklere har ofte en stressende hverdag, men de evner å ha en egen stå-på-vilje for å oppnå målene sine. Systemene de jobber i skal være effektive slik at de får fullført oppgavene de jobber med og gå videre på den neste. Derfor er det viktig at utviklerportalen gir dem informasjonen de trenger i så kortfattet og rett-til-poenget måte som overhodet mulig. Her behøver ikke ting å gjentas flere ganger eller utdypes noe mer enn nødvendig.
Samtidig som utviklernes kalendere er stappfulle, lar de ikke stresset ta overtak. De er godt likt av kolleger og er ikke redde for å slenge på en emojis eller to for å uttrykke hvordan de føler seg, eller som et virkemiddel for å Sprite opp stemningen i chaten. Emojies er derfor hjertelig velkomne i utviklerportalen (med noen begrensninger selvsagt). Les mer om bruk av emojis i dokumentasjon her.
Produkteiere har mye ansvar. De spiller som regel hovedrollen i planlegging, gjennomføring, overvåking, kontroll og avslutning av prosjekter. De er også ansvarlig for å dokumentere APIene her på utviklerportalen. Med et redaktørfokus i bakhånd dokumenteres det på en formell måte som kanskje ikke inneholder emojies i like stor grad som dersom en utvikler skulle produsert det samme innholdet.
Siden produkteiere har mye å holde fingrene i, er de opptatt av å skrive på et voksent og universelt språk. Som innholdsproduserende produkteiere i utviklerportalen har man et ansvar å huske på at det som er viktig for deg som skribent, ikke alltid er det viktigste for mottakeren.
Praktisk støtte til deg som skal produsere innhold:
Tenk på publikum som skal lese innholdet og hvilken modus de er i. Er dette første gangen de hører om produktet, tjenesten eller bedriften? Da bør det være litt lettere innhold med en verdi for målgruppen. Er innholdet mer kjent for målgruppen kan man ha «tyngre og mer konverterende innhold».
Gi en beskrivelse av alle forkortelser. Ofte kan det være utrolig tidsbesparende å anvende seg av forkortelser. Men husk på - mange forkortelser er ofte fagspråk som brukes internt i bedrifter og er ikke alltid allment kjent. Hver gang du kommer opp med en ny forkortelse er det viktig å gi leseren en beskrivelse av hva denne forkortelsen betyr. Deretter kan du bruke forkortelsen så mye du vil. Om du ønsker kan du i tillegg gi leseren en oversikt over alle forkortelsene du bruker slik som dokumentdeling har gjort her.
Kan det du skriver om lettere forstås med en illustrasjon? Mermaid lar deg lage diagrammer og visualiseringer ved hjelp av tekst og kode.
Skriv enkelt. Blir det du skriver forståelig selv om du kutter et ord eller en setning? Kutt det. Er du usikker på om du har skrevet forklarende nok? Se om du kan få en kollega som ikke kjenner til tjenesten din til å forstå det du skriver.
Spiss språket ditt. Still spørsmål til din egen tekst. Hva betyr det? Hva mener jeg å få fram her? Hvorfor skriver jeg det?
Få klart fram hvorfor leseren skal lese og bruke teksten. Om formålet med teksten er at leseren skal gjøre noe, bør du passe på at dette kommer tydelig frem.
Ta med det som er relevant for leseren. Skriv kort. Da sparer du plass, og leseren sparer tid. Tenk grundig over hva som bør være med i teksten. Kan du fjerne tekst som leseren trolig ikke har nytte av?
Sett det som er viktigst for leseren, først eller langt framme i teksten. Det som er viktigst for deg som skribent, er ikke alltid det viktigste for mottakeren. Ofte er det lurt å skrive en konklusjon eller et sammendrag først.