Språkgranskning (1 hp, bara TDDE30)

Sedan lång tid tillbaka har D- och U-programmen 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.

För D-programmet ligger detta arbete i TDDE30, medan U-programmet har motsvarande moment i en annan kurs (för tillfället TDDD92 i årskurs 3).

Det som ska granskas är det projektdokument som alla kursdeltagare ska skriva – hela dokumentet inklusive projektplan och projektrapport. 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 (på IKOS) kommer att bedöma detta, inte examinatorn eller era handledare.

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

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

• I april 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å projektdokumentet i just denna kurs. Andra delar kan ge en god förberedelse inför kommande kurser!

• 2022-05-01 har ni en möjlighet att lämna in ett preliminärt projektdokument till den externa granskaren, som inte bryr sig om själva projektet utan istället granskar dokumentets struktur och språk som en del av detta moment på 1 hp. Inkludera alltid era LiU-ID i filnamnet enligt mönstret nedan, för att göra det enklare för läsaren att hitta rätt! Inlämning sker via "Inlämningar" i Lisam.

  Vid den här tiden är projektet ännu inte klart! Tanken är då att man skriver den bästa beskrivningen man kan utifrån det man redan har, utan att utelämna några relevanta delar. Väljer man att utnyttja det här tillfället måste det alltså finnas ett i princip fullständigt dokument med strukturbeskrivning, användarmanual med mera, även om det kanske inte stämmer helt överens med vad slutresultatet av projektet kommer att bli. Om beskrivningen uppfyller kraven på struktur och språk kan man få godkänt på momentet på en gång. Annars har man i alla fall fått en möjlighet till återkoppling till en senare inlämning under kursens gång!

  Inlämningen ska innehålla båda delar, alltså både projektplan och (preliminär) projektrapport.

  Detta är en uppgift som ger 1 hp / 26 timmar UTÖVER det som man redan får för att skriva rapporten som del av programmeringsuppgiften.

  Därför måste du ta korrekturläsningen och poleringen på största allvar!

  Du kan absolut få komplettering om du inte arbetar ordentligt på att polera och fixa rapporten. Se "Att tänka på" längre ner på sidan.

  Instruktioner för dig som lämnar in:

  1. Exportera till PDF-format, t.ex. med File | Export to PDF i LibreOffice Writer. Döp filen enligt följande mönster, utan mellanslag i filnamnet. Ditt eller era LiU-ID måste alltså finnas med, i precis detta namngivningsmönster.

     liuid123-rapport.pdf om du arbetar ensam

     liuid123-liuid456-rapport.pdf om ni arbetar i par

  2. Inlämning sker via "Inlämningar" i Lisam.

  Inlämningsinstruktioner för denna omgång finns högst upp!

  • liuid123-rapport.pdf om du arbetar ensam
  • liuid123-liuid456-rapport.pdf om ni arbetar i par

• Senast 2022-05-13 får ni tillbaka kommentarer på projektdokumentet från språk- och strukturgranskarna. Eftersom denna granskning var er första möjlighet till återkoppling räknar vi med att en hel del kommer att behöva arbeta vidare i en omgång till. I en komplettering ska ni tydligt markera ändringar med gul bakgrund så att granskaren kan se vad som har ändrats.

• Om ni behövde arbeta vidare med dokumentets språk/struktur, eller inte gjorde en preliminär inlämning, kan ni lämna in till de externa granskarna senast 2022-05-22, i samband med vår slutliga projektdeadline (kom ihåg gulmarkeringarna enligt ovan).

• Oavsett hur och när ni lämnar in till språk- och strukturgranskarna måste dokumentet också lämnas in till oss via Gitlab som en del av den huvudsakliga projektinlämningen, eftersom det också är relevant för bedömningen av projektet i helhet! I den bedömningen tittar vi dock mer på att rätt information finns med och mindre på språk och struktur.

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 dokumentet för granskning i samband med tentaperioderna i augusti och oktober. Även då sker inlämningen via Lisam.

Därefter kommer nästa tillfälle att vara under kursomgången 2022 (maj/juni).

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.

• Du ska använda stavningskontroll, t.ex. den i LibreOffice. På 2020-talet finns ingen anledning till att lämna in rapporter med ord som inte existerar!

• 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.

• 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.

• Uppdatera innehållsförteckningen så att den är aktuell när du lämnar in.

Resurser

• Svenska skrivregler

• Svenska skrivregler 2017, via bibliotek

• Myndigheternas skrivregler