Göm menyn

Språkgranskning (1 hp, bara TDDE30)

Sedan lång tid tillbaka har D-programmets första år ett moment där en rapport skriven på svenska ska språk- och strukturgranskas. Anledningen till detta är att ni ska få erfarenhet av att skriva tekniska rapporter, och av vad man behöver tänka på i rapporterna, som hjälp inför framtida skrivande -- inte minst exjobb, även om det kan kännas avlägset nu. Tidigare låg detta moment i en annan kurs, men 2018 justerades och flyttades några kurser för att få en bättre ordning. Därmed flyttade också språkgranskningen över till TDDE30. (U-programmet har motsvarande moment i en annan kurs.)

Detta moment är fortfarande relativt nytt för oss alla. Är något oklart? Fråga gärna examinatorn så vi kan ta fram mer information och förtydliga!

Granskningen kommer att ske med hjälp av den projektrapport som alla kursdeltagare ska skriva. Ni får 1 hp för granskningsmomentet vilket ger er cirka 26 timmar extra, varav en stor del kan läggas på att tänka på just språket (stavning, formulering, med mera), strukturen och läsbarheten. "Externa" granskare som arbetar inom detta område kommer att bedöma rapporterna, inte examinatorn eller de vanliga handledarna.

Vi genomför momentet på följande sätt:

  • Under projektets gång skriver ni som vanligt en projektrapport och fyller den med information om projektet, kodstrukturen, designbeslut med mera. Instruktioner för detta finns på projektsidan och i projektmallen.

  • 190417 finns en föreläsning om att skriva rapporter där ni kan få veta mera om vad som är viktigt att tänka på. Denna föreläsning är inriktad på rapporter i allmänhet och olika delar kan vara mer eller mindre tillämpliga på projektrapporten i just denna kurs. Andra delar kan ge en god förberedelse inför kommande kurser!

  • Senast 190507 lämnar ni in er projektrapport till den externa granskaren, som inte bryr sig om själva projektet utan istället granskar rapportens struktur och språk som en del av detta moment på 1 hp. Inkludera gärna era LiU-ID i filnamnet för att göra det enklare för läsaren att hitta rätt.

  • (Därefter kommer projektdemonstrationen för handledarna, senast 190509, och inlämning av projektkod och rapport via Git, senast 190512. De "vanliga" handledarna kommer då att använda rapporten för att förstå projektets struktur och som en del av examinationen av 3 hp Java och objektorientering. De kommer inte att granska språk och struktur.)

  • Senast 190520 får ni tillbaka kommentarer på projektrapporten från språk- och strukturgranskarna. Vissa kan få godkänt direkt, men detta är ett moment som ni inte har övat så mycket på, där granskningen är den första möjligheten till återkoppling. Därför räknar vi med att en hel del kommer att behöva arbeta vidare i en omgång till, under terminens sista vecka. I en eventuell komplettering ska ni tydligt markera ändringar med gul bakgrund så att läsaren kan se vad som har ändrats.

  • Om ni behövde arbeta vidare med rapporten kan ni lämna in den nya versionen till de externa granskarna senast 190602 (kom ihåg gulmarkeringarna enligt ovan). Ni får då den slutliga bedömningen senast 190612.

Senare inlämning

För er som lämnar in projekt vid senare inlämningstillfällen kommer det att finnas tillfälle att lämna in rapporten för granskning i samband med tentaperioderna i augusti (deadline 190901), oktober (191103) och januari (200110). Dessa sena kompletteringar skickas till Birgitte Saxtrup Hermansson.

Efter januari kommer nästa tillfälle under kursomgången 2020.

Att tänka på

Här ger vi tips enligt tidigare års kommentarer på rapporter. Detta är alltså inte "bara" allmänna tips utan sådant som granskarna faktiskt har sett och påpekat i rapporterna i denna kurs. Tipsen kan komma att fyllas på.

Tänk på att medan vi i "Java-delen" av kursen mest bryr oss om att vi på något sätt kan förstå vad ni menar när ni beskriver programmets struktur och design, får ni också 1 hp specifikt för att arbeta med rapporten som en språkuppgift. Detta ger er en hel del tid att arbeta med just språk och struktur. Genom att satsa på detta redan i första inlämningen, och sedan ta hand om eventuella kommentarer, kan ni lära er en hel del som ni får nytta av i kommande kurser och inte minst exjobbet där korrekt rapportskrivande är en central del.

  • Eftersom detta ska vara en förberedelse inför kommande rapporter, där ni kanske skriver om något som är helt okänt för läsaren, ska ni inte anta att läsaren känner till mallen eller de instruktioner ni har fått. Ni kan till exempel behöva förklara vad milstolparna är till för, istället för att bara lista dem i en tabell.

  • Tänk på att undvika svengelska. Se t.ex. dessa listor med exempel. Svenska använder inte apostrof när man till exempel pratar om projektet's egenskaper. "Simpel" betyder torftig, tarvlig; simple = enkel.

  • Samtliga bilder/figurer/tabeller ska (1) omnämnas i löptexten, helst innan bilden/tabellen/figuren, och (2) numreras och förses med bild-/tabelltext, där tabelltexter placeras över tabeller medan övriga former av figurtexter placeras under respektive figur. Dessutom (3) bör bild-/tabelltext ha avvikande typsnitt/textstorlek. Se till att det går lätt att förstå vilken figur som texten refererar till.

  • Skriv fullständiga meningar.

  • Kör stavningskontroll, korrekturläs och korrigera.

  • Undvik satsradningar. Dela upp meningen med hjälp av punkt eller bind ihop satserna med hjälp av bindeord.

  • Avsluta mening med punkt. Ha stor bokstav efter punkt som avslutar mening. Men vid förkortning med punkt påbörjas inte ny mening efteråt -- alltså inte stor bokstav. Detta kan ordbehandlare ibland "korrigera" på fel sätt när de inte känner igen förkortningarna.

  • Undvik talspråk både på ord- och satsnivå. Exempel: Egna/eget, vårat/vårt, kollar. "Eftersom att" finns inte; det heter "eftersom" eller i vissa fall "för att". I många meningar så behövs inte "så", till exempel i denna. Det heter inte "desto mer desto bättre", utan "ju [orsak] desto [effekt]".

  • Börja inte ny mening med en förkortning.

  • Kontrollera bestämd/obestämd form.

  • Ha alltid text under en rubrik -- undvik två rubriker efter varandra utan text mellan.

  • Byt bara rad vid nytt stycke.

  • Undvik sär skrivning.

  • Om du hänvisar till andra delar av rapporten (som tidigare nämnts) så ange gärna vilket avsnitt i rapporten som avses. Det gör det lättare för läsaren att "hitta igen" det du pratar om, om man inte riktigt minns vad du tagit upp tidigare.

  • Tänk på att använda de/dem korrekt. Använd "de" där man kan använda "han/hon/vi", och "dem" där man kan använda "honom/henne/oss". Många har lättare att se att det inte ska heta "Oss gick hem" än att det inte ska heta "Dem gick hem".

  • Mer/fler: Fler av något man kan räkna (fler bokstäver), mer av något man inte kan räkna (mer mjöl).

  • Rubriker är till för att hitta i texten, men den ska gå att läsa lika bra utan att man har läst den. Har man rubriken "Fiender" kan man inte fortsätta med "Dessa är till för att...", utan bör skriva t.ex. "Fienderna är till för att...". Tips: Tänk er att ni raderar alla rubriker i hela texten och läser den helt utan att rubrikerna finns. Går det då att förstå vad man menar?

  • Korrekturläs så att ni inte glömmer att ta bort textsnuttar som inte ska vara med vid inlämning

Resurser

  • Svenska skrivregler

  • Lathund för rapportskrivning innehåller en hel del information. Avsnitt 2 om skrivprocessen, avsnitt 3 om att skriva för läsaren, avsnitt 6 om språkliga råd, och avsnitt 7 om layout är definitivt användbara även för denna rapport. I bilaga 2 (checklista) är avsnittet om språk högst relevant.

    Vissa andra delar av texten är mer anpassade till vetenskapliga rapporter, vilket projektrapporten inte är, men även dessa delar kan innehålla en hel del matnyttigt!


Sidansvarig: Jonas Kvarnström
Senast uppdaterad: 2019-08-21