Språklig klarhet

Urval av stoff, språklig stil och formuleringar bör anpassas för att ge läsaren en komplett, tydlig och lättolkad bild av det arbete som utförts. Terminologi, variabler, förkortningar och akronymer ska definieras och förklaras. Definitioner ska vara specifika och konkreta och ges i termer av koncept som är kända, tydliga och väldefinierade. Illustrerade exempel kan förtydliga en definition men kan inte ersätta den. Man bör heller inte i onödan använda synonymer.

Exempel
"Efter granskning av koden upptäckte vi att det inte fungerade med testvärdena, men efter några ändringar fick vi resultaten som syns i figur 3."
Här har man inte preciserat ändringarna och inte förklarat vad som var fel i koden.

"Efter granskning av koden upptäckte vi att det inte fungerade med testvärdena, eftersom variabeln test_1 fått fel värde. När vi ändrade det fick vi resultaten som syns i figur 3."
Här har författarna preciserat vad som gått fel, men det behövs fortfarande en förklaring av vad variabeln test_1 innehåller och hur den påverkar resultatet. Man behöver också förklara vad man ändrade variabeln till att innehålla.

"Vi använder JSON-objekt för att lagra..."
Här har man inte förklarat vad JSON är för något.

"Vi sparar information om varje skådespelare i JSON-objekt. JSON kan användas t.ex. för att lagra persondata, så det lämpar sig väl för uppgiften."
Här har man förklarat vad JSON kan användas till, men inte på något sätt definierat vad det är.

"JSON är ett textbaserat format för att lagra data (t.ex. information om en person). Vi sparar information om varje skådespelare i ett JSON-objekt."
Här har man först förklarat vad JSON är, sedan exemplifierat vad det kan användas till, och slutligen förklarat att det är det som används i arbetet (och i vilket syfte).

"Testdata kommer från mätningar från [Företag Xs] övervakningssystem, men även från våra egna mätningar. Vi använder dock samma verktyg som övervakningssystemet. Det gör att våra resultat blir mer generella."
Här har man inte preciserat vad "Det" hänvisar till, alltså vad är det som gör att resultaten blir mer generella? Det faktum att man använt testdata från två källor? Att man gjort egna mätningar? Eller att man använt samma verktyg som företaget?

"Begreppet X är ett samlingsnamn för ett nytt fenomen som handlar om att analysera mätdata. Uttrycket i sig är inte särskilt informativt, men termen antyder att det rör sig om..."
Här har man använt orden "begrepp", "uttryck" och "term" för att referera till samma sak (X). Det blir svårt att läsa.

"Begreppet X är ett samlingsnamn för ett antal olika analysmetoder för mätdata. Med begreppet X menar man dock vanligtvis..."
Här har man kortat ned, förtydligat, och konsekvent använt ordet "begrepp" för att beskriva X. (Det hade säkert gått lika bra att använda "uttryck" eller eventuellt "term".)

Texten ska inte innehålla mer än vad som krävs för att föra fram budskapet på ett tydligt sätt. Man bör generellt undvika talspråk och onödigt långa formuleringar. Istället för t.ex. "att"-satser, "när"-satser som beskriver något, bör man använda enskilda ord/fraser som uttrycker samma sak. Annars blir det lätt för ordrikt och informellt.

Exempel
"Det visade sig vara så att den ursprungliga testsviten inte gick att använda, eftersom..."
Här är man onödigt ordrik. Det räcker att skriva "Den ursprungliga testsviten gick inte att använda, eftersom..."

"Vi upptäckte skillnader som var stora mellan körtiden för X och körtiden för Y."
Här är det onödigt att använda den inskjutna som-satsen "som var stora" -- det räcker att skriva "Vi upptäckte stora skillnader mellan..."

"Det svåraste problemet var att det var så svårt att få tag på informanter och när vi lyckades hade de ofta inte tid att svara på våra frågor."
Här är det flera onödiga delar som kan kortas ned (att-sats respektive när-sats). Dessutom används "svåraste" och "svårt" i samma mening vilket gör det otympligt att läsa.

"Det största problemet var att det var jättesvårt att få tag på informanter som hade tid med våra frågor."
Här har man ersatt "svåraste" med "största" vilket är en förbättring. Dock används ordet "jättesvårt", vilket är för informellt. Den sista när-satsen har också ersatts med en som-sats vilket inte är helt lyckat.

"Det största problemet var svårigheten att få tag på informanter med tid att besvara våra frågor."
Här har man tagit bort båda de onödiga satserna, och ersatt med "svårigheten" respektive "med tid att besvara".

Tillbaka till Akademisk text