En liste af råd til specialeskrivere, især på IT-Universitetets
Softwareudviklingslinie. Der er også råd om afsluttende specialeseminar.
Planlægning
Det anbefales stærkt at planlægge i god tid, så man f.eks. kan nå
at lave et fireugersprojekt som opvarmning inden man starter på det
egentlige specialeprojekt.
Find en vejleder i god tid. Kig på IT-Universitetets
forskningsafdelinger, ikke kun på de lærere I har haft i kurser
eller projekter allerede.
Gruppestørrelse: Helst 2-3. Enkeltpersonsprojekter er mere
frustrerende, kører oftere skævt, og tager oftere mere end de seks
måneder de burde.
Målformulering
Projekttype og metode: konstruktion, teoriudvikling,
litteraturoversigt, ...
Foreløbig litteraturliste. Hvad er det nødvendige teoretiske indhold?
Lav en foreløbig tidsplan med ferier etc indregnet. Et stykke
A4-papir er 29 cm langt, så der er plads til 1 cm til hver af de 26
uger I har til projektet. Sæt datoer på, markér ferier, eksamener og
andre afbrydelser. Regn så tilbage fra afleveringsdatoen for at finde
ud af hvornår I skal være færdige med at skrive rapport, begynde at
skrive rapport, være færdige med at afprøve, færdige med at
programmere, færdige med at designe, færdige med at læse litteratur,
osv osv.
Forventninger til vejleder og evt medvejleder; fordeling af
belastning?
Forventninger til eksterne partnere: engagement, løn, kontorplads,
maskiner, ...?
Eget ambitionsniveau, forventninger til resultatet?
Planlagt erhvervsarbejde (maks 1 dag/uge, og ikke i hele perioden)?
Planlagt ferie?
Andre forpligtelser (børnepasning, langvarig sygdom i familien, ...)
Forventninger til fremtidigt job; hvordan skal specialeprojektet
bruges i jobsøgningen?
Hvilke kvalifikationer ønskes styrket gennem specialeprojektet?
Hvilket sprog skal specialet skrives på (normalt engelsk eller
dansk). Det kan være nyttigt med en ven, medstuderende eller
familiemedlem som kan korrekturlæse -- men det er selvfølgelig under
alle omstændigheder jeres eget ansvar at det er læseligt. Hvis I
skriver på engelsk, så vær sikker på at alle i gruppen er enige om
det.
Rettigheder til et evt produkt (især ved samarbejde med
virksomheder). Det virker nemmest at aftale at ingen parter
(studerende, vejleder, virksomhed, ITU) kan forhindre de andre parter
i at udnytte resultaterne efter projektet er afsluttet.
Specialet undervejs
Skriv projektdagbog løbende (evt med Wiki); især nyttigt hvis mål,
krav eller metode ikke er soleklar fra begyndelsen.
Husk at datere de dokumenter I skriver, især kladder. Ellers
sidder jeres vejleder med en bunke versioner og spekulerer på
hvilken en der er den nyeste.
Når I sender dokumenter til andre, så giv dem et for
modtageren relevant navn. Halvdelen af de dokumenter jeg
modtager hedder rapport.doc, udkast.pdf, main.ps eller lignende.
Når man modtager dokumenter fra seks forskellige projektgrupper
virker det mere begavet hvis de hedder jesper-20041002.pdf og
lignende. Men I øvrigt er sandsynligheden for at noget bliver
læst større hvis jeg får det udskrevet, på papir.
Specialerapporten
Når I skal til at skrive specialerapporten, så lav en omhyggelig
disposition, diskutér den med vejlederen, og sæt så omtrentlige
sidetal og dato for færdiggørelse af de enkelte kapitler på. Det er
ofte en fordel at få en eller flere medstuderende til at læse
rapporten når den nærmer sig færdiggørelse, både for at undgå
indforståethed og for at undgå de værste stavefejl og sproglig
ubehjælpsomhed.
Mht disponering af specialerapporten, så kan man i et
softwareudviklingsprojekt tage udgangspunkt i vejledningen Udformning af Rapporter eller Writing Reports. Den er ganske vist
beregnet på fireugersprojekter, men de angivne afsnit og gode råd er
relevante (og der er så vidt vides ingen på ITU der har skrevet en
vejledning i udformning af specialerapporter).
Husk at hvis specialet er skrevet på dansk, så skal der være et
resumé på engelsk eller et andet ikke-skandinavisk fremmedsprog.
Der findes en omfattende litteratur om at skrive tekniske
rapporter, universitetsspecialer, osv. Vigtigst er formålet:
The purpose of the report is to present information og
hensynet til læseren: When writing your report, you [should]
continuously bear in mind the busy reader, who has only a limited time
to devote to your report and who, in addition, may not be very
familiar with your subject. Disse citater er fra et NASA-dokument om tekniske rapporter
(1964).
Et gammelt men interessant stykke litteratur om datalogisk
projektarbejde er Peter Naur: Project Activity
in Computer Science Education. Pubblicazione N. A 70-10, Istituto
di Elaborazione della Informazione, Consiglio Nationale delle
Richerche, Pisa 1970.
David Parnas (1986) beskriver nogle af problemerne i dårlig
teknisk dokumentation, som man selvfølgelig skal undgå:
Boring prose: Lots of words are used to say what could be said
by a single programming language statement, a formula, or a diagram.
Certain facts are repeated in many different sections. This increases
the cost of the documentation and its maintenance. More important, it
leads to inattentive reading and undiscovered errors.
Confusing and inconsistent terminology: Any complex system
requires the invention and definition of new terminology. Without it
the documentation would be far too long. However, the writers of
software documentation often fail to provide precise definitions for
the terms that they use. As a result, there are many terms used for
the same concepts and many similar but distinct concepts described by
the same term.
Myopia: Documentation that is written when the project is nearing
completion is written by people who have lived with the system for so
long that they take the major decisions for granted. They
document the small details that they think they will forget.
Unfortunately, the result is a document useful to people who know the
system well, but impenetrable for newcomers.
William Safire, en amerikansk skribent, har en morsom kort opsats
om at skrive korrekt engelsk:
Remember to never split an infinitive.
The passive voice should never be used.
Do not put statements in the negative form.
Verbs has to agree with their subjects.
Proofread carefully to see if you words out.
If you reread your work, you can find on rereading a great deal of
repetition can be avoided by rereading and editing.
A writer must not shift your point of view.
And don't start a sentence with a conjunction.
(Remember, too, a preposition is a terrible word to end a sentence
with.)
Don't overuse exclamation marks!!
Place pronouns as close as possible, especially in long sentences, as
of 10 or more words, to their antecedents.
Writing carefully, dangling participles must be avoided.
If any word is improper at the end of a sentence, a linking verb is.
Take the bull by the hand and avoid mixing metaphors.
Avoid trendy locutions that sound flaky.
Everyone should be careful to use a singular pronoun with singular
nouns in their writing.
Always pick on the correct idiom.
The adverb always follows the verb.
Last but not least, avoid cliches like the plague; seek viable
alternatives.
Normalt skrives et speciale i Microsoft Word eller i LaTeX. Brug
systemets faciliteter til at autonummerere kapitler, afsnit og
underafsnit; til at autonummerere figurer osv; og til automatisk at
holde krydshenvisninger opdaterede. Her er en kort vejledning i struktureret
brug af Word.
I specialet skrives henvisninger til websider i litteraturlisten,
f.eks.
[23] Moscow ML homepage. URL <http://www.dina.kvl.dk/~sestoft/mosml.html>
Seen January 2003.
Men trykte kilder er altid at foretrække hvis de findes.
I højtudviklede tekstbehandlingssystemer (TeX, LaTeX) skrives
litteraturhenvisninger bedst på formen [23], svarende til
bibliography style plain. Der gives normalt ikke sidehenvisninger
undtagen for citater.
Til slut en, skulle man tro, helt overflødig advarsel: Plagiat
er forbudt. Hvis en rapport indeholder tekst taget fra bøger,
artikler eller websider uden korrekt kildehenvisning og uden at det er
helt klart at I ikke selv har skrevet denne tekst, så er specialet
dumpet og I risikerer bortvisning fra universitetet. Dette gælder
ikke blot den endelige aflevering, men også jeres kladder. Jeg har
heldigvis aldrig set plagiat i specialer jeg har vejledt, men desværre
i projektrapporter -- hvor det er lige så ulovligt, stupidt og
uhæderligt.
Last but not least, a warning that ought to be wholly unnecessary:
Plagiarism is illegal. If a report contains text taken from a
book, paper or web site without correct reference to the source and
without making it entirely clear that you have not yourself written
that text, then the MSc thesis is automatically failed and you risk
being kicked out of university. This holds not only for the final MSc
thesis report, but also your drafts. Fortunately I have never seen
plagiarism in MSc theses I have supervised, but sadly, I have seen it
in project reports -- where it is no less illegal, stupid and
dishonest.