Technical Writing Essentials

Deskriptiv teknisk skrift använder en kombination av bilder och text för att både ”visa” och ”berätta” för läsaren om den information som förmedlas. Liksom mer kreativa beskrivningar använder sig tekniska beskrivningar ibland av de ”fem sinnena” och metaforiska jämförelser (analogier) för att läsaren helt och hållet ska kunna föreställa sig det som beskrivs. Oftare förlitar de sig dock på konkreta, mätbara beskrivningar. Tekniska beskrivningar kan ha många olika former, beroende på syfte och målgrupp. Beskrivningar kan vara allt från en kort mening till ett stycke, ett helt avsnitt i en rapport eller en hel handbok. Dåligt skrivna tekniska beskrivningar kan skapa förvirring, slösa tid och till och med leda till en katastrof! Tekniska produktbeskrivningar är ofta lagstadgade krav för att garantera säkerhet och överensstämmelse. Det är viktigt att vara uppmärksam på detaljer.

Produktspecifikationer kräver detaljerade beskrivningar av konstruktionsegenskaper; instruktioner kräver ofta specifika beskrivande detaljer för att ”visa” läsaren vad han eller hon ska göra. Några allmänna kategorier av tekniska beskrivningar är följande:

• Mekaniska beskrivningar: ger en detaljerad översikt över de fysiska aspekterna av ett verktyg, en maskin eller annan mekanisk anordning som har rörliga delar och är utformad för att utföra en specifik funktion. Det kan röra sig om produktbeskrivningar för försäljning eller tillverkning, dokumentation av konstruktionsspecifikationer, infografik osv. Det här kapitlet fokuserar i detalj på denna typ av beskrivningar.
• Processbeskrivningar: beskriver i detalj en serie händelser (naturliga/biologiska/ekologiska, mekaniska, sociala eller psykologiska fenomen) som inträffar i en viss ordning för att uppnå ett visst resultat. Dessa kan kategoriseras i icke-instruktiva processer (t.ex. processanalyser av hur en förbränningsmotor fungerar, eller naturliga processer som fotosyntes) och instruktiva processer (t.ex. rekommenderade/krävda förfaranden och explicita steg-för-steg-instruktioner som ska följas). (Se avsnitt 7.7 för detaljerad information om att skriva instruktioner).
• Definitioner: klargör den specifika innebörden, ofta relaterad till ett specifikt sammanhang, eller uttrycker den väsentliga karaktären hos de termer som definieras. Dessa kan vara av olika längd, från en enkel förtydligande fras till ett omfattande dokument på flera sidor. Definitioner innehåller ofta detaljerade beskrivningar och bilder för att illustrera idéer. Klicka på länken nedan för att se en PowerPoint-presentation om hur man skriver effektiva definitioner för tekniska ändamål. Presentationen ingår med uttryckligt tillstånd av studenten.

Definitioner i tekniskt skrivande – Exempel på studentpresentation (.pdf)

Mekanikbeskrivningar bör ge en tydlig förståelse för det objekt som beskrivs, inklusive

• Allmänt utseende och fysikaliska egenskaper
• Övergripande funktion/syfte
• Komponentdelar
• Hur delarna interagerar för att skapa en fungerande helhet.

Läsaren ska tydligt kunna föreställa sig, och därmed förstå, karaktären hos det objekt som beskrivs, vad det gör och hur det fungerar.

För att uppnå denna tydlighet för läsaren måste skribenten välja viktiga detaljer och organisera informationen logiskt. Välj detaljer som kan beskrivas exakt och mätbart, till exempel

Avhängigt av läsarens behov kan beskrivningen sträcka sig från en allmän översikt som endast kräver några få meningar till en handbok med flera kapitel som beskriver varje aspekt av mekanismens delar och funktioner för att man ska kunna felsöka tekniska problem och utföra reparationer. Ett roligt exempel på det sistnämnda är Star Trek: The Next Generation: Technical Manual (omslaget visas i figur 7.4.1), som innehåller detaljerade beskrivningar av all utrustning och teknik som används ombord på den fiktiva U.S.S. Enterprise-D.

Innan du börjar skriva din beskrivning måste du tänka på ditt syfte och din målgrupp: Varför behöver din målgrupp denna beskrivning? Vad kommer de att använda den till? Ska du beskriva olika typer av solpaneler för genomsnittskonsumenter för att hjälpa dem att välja den som bäst passar deras behov? Ska du ge scheman till tekniker och installatörer?

När du har ditt syfte och din målgrupp klart i fokus kan du skriva en beskrivning som innehåller följande delar:

1. Definition: Vad är det och vad är dess huvudsyfte?
2. Översikt: Beskriv mekanismens övergripande utseende (”helhetsbild”).
3. Komponenter: Beskriv mekanismens övergripande utseende (”helhetsbild”): Beskriv de viktigaste komponenterna i märkta avsnitt; tänk noga på informationens ordning här. Skapa ett logiskt samband mellan varje komponent som beskrivs.
4. Förklaring: Hur fungerar delarna tillsammans för att uppfylla dess funktion? Vilka nyckelprinciper styr dess funktion? Överväg hur mycket detaljer som behövs här för den avsedda målgruppen.
5. Visuellt material: inkludera grafik som tydligt illustrerar mekanismen och/eller dess delar. Visa anordningen som helhet; överväg att visa specifika detaljer i utvidgade vyer, utklipp eller märkta diagram. Du kan även bädda in eller länka till videor som visar anordningen i aktion.
6. Slutsats: Beroende på syftet kan du gå igenom produktens historia, tillgänglighet, tillverkning, kostnader, varningar etc.)
7. Referenser: Källor som du har använt i din beskrivning, eller ytterligare tillgängliga informationskällor (om det är relevant).

Du kan överväga att använda en mall, som t.ex. mallen för teknisk beskrivning nedan, men tänk på att även om mallar kan vara användbara som vägledning ger de inte mycket flexibilitet och kanske inte fungerar i alla situationer.

Exempel på beskrivningar

Titta på beskrivningen av ”Up Goer Five” i figur 7.4.2 (klicka på bilden för större version). Vem kan den tänkta målgruppen vara?

Genomför beskrivningen i figur 7.4.2 med den information som ges på NASA:s webbplats om Mars Curiosity Rover.

Notera skillnaderna i detaljnivå, ordförråd och övergripande syfte i beskrivningarna. Om du använde informationen på NASA:s webbplats för att fylla i mallen för tekniska beskrivningar skulle du kanske få något som liknar följande diagram. Mål

Du kan komma fram till att en del av dessa delar inte är nödvändiga; fundera återigen på vad din målgrupp redan vet. Sträva efter en balans mellan att i onödan säga det uppenbara och att felaktigt anta att dina läsare har kunskaper som de saknar.

Vid förfining av detaljerna i din beskrivning och dess beståndsdelar, tänk på följande:

• Organisation: Använd en logisk princip för att organisera din beskrivning
  • Topp till botten (eller grunden uppåt)
  • Vänster till höger (eller höger till vänster)
  • Invändigt till utvändigt (eller utvändigt till invändigt)
  • Viktigaste till minst viktiga egenskaper
  • Centrala komponenter till perifera komponenter
  • Materialegenskaper, etc.
• Språk: Använd specifika, exakta, konkreta termer – undvik vaga eller alltför allmänna termer
  • Använd korrekt terminologi – definiera termerna så att de är nödvändiga för din publik
  • Använd analogi för att beskriva en obekant sak i termer av en bekant sak
  • Använd ett objektivt språk – inget ”ad speak” eller subjektiva termer
  • Använd nutid, aktiva verb för att beskriva hur apparaten ser ut och vad den gör
  • Använd ord som skapar levande och specifika bilder i läsarens huvud.

Välj ett vanligt, vardagligt föremål (t.ex. ett av föremålen i figur 7.4.3) och skriv en teknisk beskrivning för en publik som inte känner till föremålet. Börja med att föreställa dig en målgrupp och ett syfte och försök sedan fylla i mallen för teknisk beskrivning med detaljerad information. Med hjälp av informationen i din mall utarbetar du en kort beskrivning på 1-2 stycken och lägger till korrekt bildtexter.