Hur använder man enkla ord i tekniskt skrivande?
Ett sätt att tekniskt skriva gör saker lättare att förstå är att använda en enkel, rakt framåt skrivstil, inklusive enkla ord.
Tekniskt skrivande betraktas som en form av skriftlig kommunikation som innehåller minst en av följande tre punkter: (1) att skriva om ett mycket specifikt och tekniskt ämne (t.ex. resultatet av en hjärtoperation); (2) beskriva hur man använder teknik för att göra kommunikationen (t.ex. webbplatser, bloggar, etc.); eller (3) dokumentera en process eller procedur (t.ex. hur man använder MS Excel). Tekniskt skrivande antar att man tar ett komplext och komplicerat ämne och gör det lättare att förstå och tolka. Ett sätt att tekniskt skriva gör saker lättare att förstå är att använda en enkel, rakt framåt skrivstil, inklusive enkla ord.
Del 1 av 1: planera framåt
- 1Vet vem din publik kommer att bli. Innan du påbörjar något tekniskt skrivprojekt är det första du behöver fråga dig själv vem som kommer att vara användaren av ditt dokument. Finns det mer än en typ av användare? Vilken typ av kunskap och erfarenhet kommer användaren att ha om ämnet? Vad kommer den användaren att använda mitt dokument för att göra? Hur ofta behöver de hänvisa till mitt dokument? Kommer användaren att förstå jargongen för ämnet?
- Användare av tekniskt skrivande kan falla i flera olika kategorier, var och en med sina egna specifika behov: kunder, slutanvändare, installatörer, utvecklare, utbildare och praktikanter eller teknisk support.
- Du kommer sannolikt inte att kunna skriva ett separat dokument för varje användare, så du måste ta hänsyn till alla potentiella användares behov när du skriver.
- 2Utveckla målen för ditt skrivande. När du väl har fått reda på vem din publik är måste du ta reda på hur dessa användare kommer att använda dokumentet. I allmänhet faller dokumentets mål i en av två kategorier: uppgiftsbaserad eller referensbaserad. Uppgiftsbaserade dokument är ur perspektivet av vad användaren gör, medan referensbaserade dokument är ur perspektivet på vad produkten gör.
- Ett exempel på ett uppgiftsbaserat dokument kan vara instruktioner om hur du skapar en webbplats i Wordpress. I den här situationen går du igenom alla steg från början till slut, oavsett var dessa steg förekommer i Wordpress-programvaran.
- Ett exempel på ett referensbaserat dokument kan vara en användarmanual för en Blu-Ray-spelare. I den här situationen skulle du förklara varje del av maskinen separat - vad varje knapp, funktion, menyalternativ etc. gör.
- 3Organisera dig i förväg. Att planera hela din skrivprocess är ett effektivt och effektivt sätt att närma sig ditt projekt. Ett bra tillvägagångssätt inkluderar: samla in informationen, planera och organisera informationen, skriva, verifiera och testa, och göra om och revidera om. Även om detta tillvägagångssätt ser ut som det har 5 snygga steg är det faktiskt en cirkulär process. När som helst i detta tillvägagångssätt kan du behöva gå tillbaka till ett tidigare steg.
- Att samla in informationen inkluderar: läsa allt du kan om ämnet; använda produkten själv; förstå vad dina användare behöver veta om artikeln; intervjua de personer som utvecklat artikeln; delta i möten där artikeln diskuteras i detalj och lyssna på vad som sägs; och låta varuexperterna ge dig feedback om du har något fel.
- Planering och organisering av informationen inkluderar: ta reda på exakt vad det är du behöver skriva om (dvs. vad är dina leveranser); utveckla ett schema för ditt arbete; och granska din plan med nödvändiga personer för att se till att den uppfyller förväntningarna.
- Skrivning görs mest effektivt genom att: skapa en fullständig översikt över ditt dokument, inklusive alla ämnen du tänker täcka; faktiskt skriva ut varje kapitel och avsnitt; och bestämma när du inte har tillräckligt med information för att avsluta ett visst kapitel eller avsnitt och behöver göra mer forskning.
- Verifiering och testning är där du ser till att ditt dokument faktiskt gör vad det var tänkt att göra, exakt. Börja med att försöka använda ditt eget dokument - gör alla steg meningsfulla, är det något som saknas etc. Läs igenom dokumentet för objekt som inte är innehåll som grammatik, stavning, format osv. Slutligen måste du ge ditt dokument till en eller flera experter och be dem granska den.
- Att göra om och ändra är där du tar all feedback du har fått, inklusive från dig själv, och uppdaterar ditt dokument med dessa objekt. Och beroende på hur dokumentet ska användas kan det innehålla konstanta granskningar och uppdateringar över tiden, eftersom dokumentet används och problem hittas.
4- Vet i förväg att det inte kommer att bli perfekt. Tyvärr får de flesta tekniska författare betalt för att producera ett dokument antingen inom en viss tidsram eller för ett fast pris. Chansen är stor att du kan behöva kompromissa med en sak för att säkerställa att något annat kan hända. Det här kan verka som en hård idé för att få huvudet, men det är en olycklig verklighet med många arbetsmiljöer och situationer.
- Det viktigaste att komma ihåg är att ett tekniskt dokument bör - först och främst - vara korrekt.
- Dokumentet bör också vara så komplett som möjligt. Det borde inte finnas några saknade steg som kan förvirra en användare.
- När du har uppnått de "exakta" och "kompletta" delarna kan du oroa dig för skrivfel, formatering, tabeller, listor etc.
Enkelt betyder också att man använder mindre ord när det är möjligt, snarare än stora, komplexa ord som inte hjälper till att förklara poängen.
Skriva så att alla förstår
- Undvik jargong och slang. Vid denna tidpunkt bör du vara helt medveten om vem din publik är, och om de redan har kompetensen att förstå den tekniska jargongen som är kopplad till ditt ämne. Om hela publiken består av expertanvändare bör det inte vara ett problem att använda jargong. Men om din publik består av någon som inte är en expertanvändare, är det bättre att undvika att använda jargong så ofta som möjligt. De flesta, om inte alla, har jargong vanliga ord som kan användas istället. Några exempel på jargong inkluderar:
- "Manus" - i teknisk mening avser detta datorkod, men den genomsnittliga personen kanske tror att detta betyder ett manus för en pjäs eller film.
- "Unsub" - den här termen används mycket i tv-serier och filmer. Det betyder ett "okänt / oidentifierat ämne." Men för en lekman betyder denna term förmodligen ingenting.
- "Due diligence" - i affärsmässig mening innebär detta att göra fullständig forskning om något innan du fattar ett beslut. Det kan inte betyda något för en lekman, eller de kan tolka orden individuellt.
- ” Vänster” eller”höger” - ur ett politiskt perspektiv hänvisar det till hur liberal eller konservativ någon är, men många lekmän känner inte till termerna. Skriv istället ut liberala eller konservativa.
- Stava ut förkortningar och akronymer. När du använder förkortningar ska du alltid stava hela namnet först och sedan placera förkortningen inom parentes efter den fullständiga beskrivningen (t.ex. European Library Association (ALA)). För resten av avsnittet eller kapitlet kan du använda förkortningen istället för hela namnet (t.ex. ALA).
- Var medveten om att akronymer inte nödvändigtvis är samma sak som förkortningar. Akronymer är endast korta bokstäver som förkortningar, men till skillnad från förkortningar kan bokstäverna uttalas som ett ord. Till exempel skulle ALA ha varje bokstav uttalad separat när man säger det, medan LAN inte stavas, det förvandlas till ett ord.
- Definiera okända ord eller termer. Det finns många vetenskapliga eller tekniska termer som du kommer att behöva använda i ditt skrivande, men kan vara okända för någon eller hela din publik. När du använder ett ord eller term som inte ingår i vardagsspråket, definiera det första gången du använder det. Du kan definiera den genom att antingen lägga definitionen i en uppsättning parenteser efter termen (t.ex. sätta definitionen här), eller så kan du skapa en ordlista som gäller för hela dokumentet. Om du bestämmer dig för en ordlista, markera ordet eller termen på ett sådant sätt för att varna läsaren om att hänvisa till ordlistan för dess definition (t.ex. fet, kursiv, understruken, etc.).
- Ett alternativ till en hela ordlistan är en tabell som definierar viktiga ord och termer i början av varje kapitel. Användare skulle läsa definitionerna innan de läste innehållet. Med definitionerna färska i minnet blir innehållet mer förståeligt.
- Undvik att använda klichéer, även om du tror att majoriteten av publiken förstår dem.
- Kom ihåg att mindre är mer. När du försöker förklara något tekniskt för den genomsnittliga personen, använd så få ord som möjligt för att få din poäng. Det är inte nödvändigt att förklara allt det sista du säger i enorma detaljer. Kom ihåg vem din publik är - om du skriver en användarmanual för en DVD-spelare behöver du inte förklara hur kretskorten inuti DVD-spelaren fungerar. Du behöver bara förklara vad som händer när du trycker på en viss knapp. Detta förslag inkluderar också att välja minst antal ord som behövs för att göra en poäng - undvik redundans.
- Ett exempel på en redundant uttalande är: "vattenkvaliteten i Athabasca floden sjönk i maj i minskningen skedde på grund av kraftiga regn denna månad Allt.. Extra vatten överbelastad Yellow länet är vattenreningsverk."
- Samma exempel skrivet utan redundans är: "Vattenkvaliteten i floden Athabasca sjönk i mars eftersom kraftiga regn överbelastade vattenreningsverket i Yellowhead Country."
- Exempel påståenden (med onödiga ord inom parentes) är som följer:
- (redan) existerande
- för närvarande)
- (fortsätt) kvar
- (tomt utrymme
- blanda ihop)
- aldrig tidigare)
- börja)
- ingen alls)
- Lägg nyckelinformationen framför. När du gör en punkt i tekniskt skrivande, lägg de viktigaste delarna först. När nyckelinformationen har angetts kan du följa upp en förklaring till varför den hände eller vad som orsakade den.
- Säg inte "Trots fem straffar i den första och andra perioden av matchen lyckades Maple Leafs fortfarande vinna", när du kan säga "Maple Leafs vann, trots fem straffar under första och andra perioden."
- Lägg till humor. Tekniskt (och vetenskapligt) skrivande är inte känt för sin humor, och det är inte nödvändigtvis bra. Att lägga till lite humor på rätt plats hjälper läsaren att vara uppmärksam. Torrt, tråkigt och repetitivt tekniskt skrivande tenderar att tappa läsarens uppmärksamhet ganska snabbt. Ett bra ställe att sätta humor är i exempel.
Innan du påbörjar något tekniskt skrivprojekt är det första du behöver fråga dig själv vem som kommer att vara användaren av ditt dokument.
Med enkla ord
- Håll det rakt framåt. Enkel, okomplicerad skrivning, särskilt i ett tekniskt dokument, hjälper till att säkerställa att läsaren inte missförstår vad som sägs. Detta innebär att hålla dina förklaringar och avsikter tydliga. Allt du skriver ska bara ha en mening eller tolkning. Enkelt betyder också att man använder mindre ord när det är möjligt, snarare än stora, komplexa ord som inte hjälper till att förklara poängen. Stora, komplexa ord kan också få författaren att verka arrogant och kan få din läsare att tappa intresset.
- Ett exempel på en oklar instruktion är: "Systemet ska frigöra lagringsutrymme efter behov först in, först ut (FIFO) eller något annat definierat prioritetsschema."
- Ett exempel på en tydlig instruktion är: "Systemet tar bort äldsta inspelningar först när det finns plats för nya inspelningar."
- Några exempel på komplexa kontra enkla ord är följande:
- användning kontra användning
- funktionalitet kontra funktion
- underlätta mot orsak
- slutföra mot slut
- nämnda vs. nämnda
- individualiserad kontra individ
- hittills jämfört med tidigare
- Använd en aktiv röst. Att använda en aktiv röst betyder att ämnet för en mening (dvs. substantivet) utför någon form av handling, i motsats till den handling som utförs på ämnet (dvs. passiv röst). Aktiv röst hänvisar också till vilka typer av verb som används. Aktiv röst tenderar att vara lättare att förstå vid läsning och låter mer självsäker.
- Ett annat sätt att tänka på vilka verb du använder är att överväga om de måste föregås av "att vara", "är", "var", "var", "har varit" och "har varit". Om dessa extra ord krävs, är verbet antagligen skrivet med en passiv röst och bör skrivas om.
- Passiv röst tenderar också att skrivas som något som hände tidigare, medan du borde skriva som om allt händer just nu.
- Ett exempel på ett uttalande med en passiv röst: "Mannen blev biten av hunden."
- Ett exempel på ett uttalande med en aktiv röst: "Hunden bet mannen."
- Om du är osäker på om det du har skrivit är rakt fram, läs det högt för dig själv.
- Undvik abstrakta substantiv. Substantiv finns i två typer - konkreta och abstrakta. Konkreta substantiv är objekt som du faktiskt kan uppleva med dina fem sinnen. Till exempel sten, DVD-spelare, motor, blå tråd etc. Abstrakta substantiv är föremål relaterade till känslor, värden, kvaliteter, begrepp etc. Till exempel lugn, ondska, ärlighet, mognad, talang, misstro, kärlek, död, drömmar etc. Ett tekniskt dokument bör försöka förklara för en läsare HUR man gör något på ett rakt fram och konkret sätt. Abstrakta substantiv kan sluta distrahera läsaren från den punkt du försöker göra.
- Ett exempel på var abstrakta substantiv används: "Den existerande naturen hos Mount St. Helens vulkaniska askkanal hanterades genom tillämpad användning av datormodelleringsfunktioner."
- Ett exempel på var konkreta substantiv används: "Med Cray-datorer modellerade vi hur mycket aska som sprutades från Mount St. Helens."
- Var försiktig med pronomen. Uttal som "det" och "detta" kan sluta förvirra läsare eftersom de flesta uttalanden du skriver kommer att hänvisa till flera substantiv. Ett pronomen har i allmänhet något som kallas ett antecedent. Antecedenten är substantivet som pronomen hänvisar till. Till exempel: Min hund jagade pinnen och tog tillbaka den. Ordet "stick" är substantivet och "det" är pronomen. Pronomen "det" hänvisar till de tidigare "stickarna". Helst bör du upprepa substantivet när det är möjligt (t.ex. min hund jagade pinnen och tog tillbaka pinnen), eller omformulera meningen så att pronomen inte krävs (t.ex. min hund jagade och tog tillbaka pinnen).
- Ett exempel på ett uttalande där pronomen används: "Bildskärmen måste anslutas till datorn, den ska vara tillräckligt nära för att en kabel ska kunna nå." Vad hänvisar "det" till? Skärmen eller datorn?
- Ett exempel där pronomen inte används: "Bildskärmen måste vara tillräckligt nära datorn så att kabeln når."
- Använd konsistens. Tekniskt skrivande kan innehålla många ord som potentiellt kan skrivas på flera sätt. Till exempel e-post kontra e-post. Eller logga in kontra inloggning kontra inloggning. Vilket alternativ du väljer att använda är upp till dig (eller vem som betalar dig), men när du väl har valt ett alternativ, använd det konsekvent i hela dokumentet. Att gå fram och tillbaka mellan "inloggning" och "inloggning" kommer att orsaka förvirring för läsaren. Andra saker att hålla konsekvent är:
- Starta punktlistor i samma format varje gång och använda samma skiljetecken varje gång.
- Använda samma villkor i hela dokumentet och bestämma vilka poster som ska aktiveras.
- Bestäm om du ska använda sammandragningar eller inte, och håll dig vid det.
- Bestäm om du ska stava ut siffror eller bara använda det faktiska numret. I många tekniska dokument stavas siffrorna noll till nio vanligtvis, medan alla siffror som är tvåsiffriga eller mer skrivs som ett tal.
- Bestäm hur du ska använda formatering som BOLD, ITALICS och UNDERSTRECK och håll den konsekvent.
- Var exakt. Att vara exakt i teknisk skrift innebär att man undviker vaga termer som är onödiga för att få fram er poäng. Ord som "otaliga", "vissa", "ungefär", "enorma", "små", etc., är onödiga i de flesta situationer. Specifika exempel på hur du ändrar ditt skrivande för att vara mer exakt är följande:
- Säg inte "Det finns många reservdelar tillgängliga" när du bara kan säga "Reservdelar finns tillgängliga."
- Säg inte "En riktigt stark lukt märktes" när du kan säga "En skarp lukt märks."
- Säg inte "Använda det diagnostiska systemet som är installerat på huvudsystemet..." när du helt enkelt kan säga "Använda diagnossystemet..." eller "Använda diagnossystemet ombord på huvudsystemet..."
- Om det finns ett specifikt nummer kopplat till det du pratar om, använd numret när du hänvisar till det objektet, inte en fras på hög nivå. Använd till exempel "Det finns tio möjliga orsaker till att detta kan hända:" snarare än "Det finns ett antal möjliga orsaker till att detta kan hända:".
Enkel, okomplicerad skrivning, särskilt i ett tekniskt dokument, hjälper till att säkerställa att läsaren inte missförstår vad som sägs.
- Helst bör författare sträva efter en distraktionsfri miljö när de skriver. Det innebär att stänga av din mobiltelefon, inte kontrollera din e-post, inte svara på telefonen etc. Om du inte har några distraktioner kommer du att bli förvånad över hur mycket du kan göra när du börjar skriva!
- Chicago Manual of Style tenderar att vara källan till stilriktlinjer för icke-akademiska författare. Överväg att köpa en online-prenumeration på webbplatsen eller köpa en papperskopia av boken så att du alltid kan hänvisa till den.
När du gör en punkt i tekniskt skrivande, lägg de viktigaste delarna först.
- Använd listor i teknisk skrift
- Krista Van Laan, Insider's Guide to Technical Writing (Laguna Hills, CA: XML Press, 20120), kapitel 7
- Van Laan, Insiderhandboken, kapitel 8
- Van Laan, Insiderhandboken, kapitel 9
- Van Laan, Insiderhandboken, kapitel 11
- Van Laan, Insiderhandboken, kapitel 18
- Van Laan, Insiderhandboken, kapitel 18
- Phillip A. Laplante, Technical Writing: A Practical Guide for Engineers and Scientists (Boca Raton, FL: CRC Press, 2012), 24-25
- Laplante, Technical Writing, 21
- http://web.mit.edu/me-ugoffice/communication/technical-writing.pdf
- http://web.mit.edu/me-ugoffice/communication/technical-writing.pdf
- Laplante, Technical Writing, 26-27
- Laplante, Technical Writing, 30-31
- http://web.mit.edu/me-ugoffice/communication/technical-writing.pdf
- Laplante, Technical Writing, 32
- https://writing.wisc.edu/Handbook/CCS_activevoice.html
- http://web.mit.edu/me-ugoffice/communication/technical-writing.pdf
- http://web.mit.edu/me-ugoffice/communication/technical-writing.pdf
- http://grammar.yourdictionary.com/parts-of-speech/nouns/concrete-noun.html
- http://examples.yourdictionary.com/examples-of-abstract-nouns.html
- http://web.mit.edu/me-ugoffice/communication/technical-writing.pdf
- http://web.mit.edu/me-ugoffice/communication/technical-writing.pdf
- http://grammar.ccc.commnet.edu/grammar/pronouns1.htm
- Van Laan, Insiderhandboken, kapitel 18
- Laplante, Technical Writing, 17-20
- http://chicagomanualofstyle.org/home.html
Läs också: Hur undviker man vanliga stavfel?
Kommentarer (4)
- Jag lär mig att förvandla mitt skrivande till nästa nivå.
- "Det" och "det här" tipset är lysande. Tack.
- Jag är ny på att skriva och de här tipsen hjälpte mycket. Den aktiva och passiva informationen var särskilt hjälpsam!
- Naturligtvis är det användbart.
