Dokumentation till programkod

Jag ska skriva dokumentation till mitt program som utför symbolisk derivering av ett uttryck man matar in.

Lite av det som dokumentationen ska innehålla:

1. titel, författarnamn, uppgift om att detta är inlämningsuppgift 1 på denna kurs detta år, innehållsförteckning, inledning med sammanfattning av vad programmet gör.
2. en "användarbeskrivning": en anvisning för hur man praktiskt använder ditt program för att utföra symbolisk derivering, inklusive körexempel. Körexemplen skall vara valda så att de illustrerar alla olika fall som kan uppstå.
3. en "programdokumentation": en beskrivning av hur ditt program egentligen fungerar:
   beskrivning av hur din abstrakta datatyp för uttryck fungerar, hur du har representerat uttrycken och hur man skall använda den abstrakta datatypen
   beskrivning av hur deriveringen fungerar, vilka uttryck som kan deriveras och hur man skall använda deriveringsfunktionen
   beskrivning av hur förenklingen av uttryck fungerar och vilka typer av förenklingar som utförs.
4. Beskrivning av kända brister hos programmet. Det kan vara sådant som du själv tycker är mindre lyckat gjort, funktioner enligt uppgiften som du trots tappra försök inte lyckats få till ordentligt eller saker som du tycker programmet borde göra fastän det inte krävs i uppgiften.

Nu undrar jag om det är någon som har en bra mall man kan utgå ifrån eller ett exempel på en dokumentation. Hur upplägget bör se ut med innehållsförteckning osv. :)

Har precis knåpat färdigt på min dokumentation. Om någon har lust att kika på den och ge kommentarar, vad som är dåligt eller bra, så skulel jag bli jag glad. Förstår dock om man inte orkar läsa :)

Min dokumentation

r) Läste snabbt igenom och fixade till vissa stavfel

Hallåj Gein!
Visst skulle det vara kulens att sätta lite fina kommentarer på nattekvisten på din dokumentation men för min del funkade det inte ens att läsa den.
Inte för att det var sååå pass många stavfel ;) , nejdå-nejdå, fallet var att när jag skulle ta öppna filen, så kom en - lika trevlig och välönskad - meddelanderuta x( där det stod typ att:
"Det går inte läsa den från Anteckningar, pågrund av att den är för stor. Vill du läsa den från WordPad?"
Visst, sa jag och tröck glatt på JA men väl inne där, så ramlade det ner bara en massa krussiduller och nummer så...sorry :(

MVH
/Cheezes - kastar ut en ouppfostrad kommentar till datorn istället... x( !"#¤¤#%&%/(?%&#"!!!!!

Cheezes:
Prova med Adobe Acrobat Reader.

ps skrev:

Cheezes:
Prova med Adobe Acrobat Reader.

Jo, men visst, efter försök nummeros treos, så såg jag att det var faktiskt en pdf.fil :i men tyvärr :( - igen - så har jag inte det programmet installerat på min dator men jag har en massa andra feta program, som tar upp hela min hårddisk så...

Tack ändå, ps :)

MVH
/Cheezes