TSEA56 - Kandidatprojekt i elektronik

Teknisk dokumentation och användarhandledning

Allmänt

Den tekniska dokumentationen ska vända sig till personer med ungefär samma grundkunskaper som ni har, och ska kunna användas som:
· Konstruktionsunderlag för någon annan som vill bygga en kopia av er apparat.
· Dokumentation för underhåll och felsökning av både hård- och mjukvara.

Den tekniska dokumentationen ska således innehålla en beskrivning av hur produkten är konstruerad. Underlag för detta hittar ni till största delen i er designspecifikation. Det bästa är således att utgå från denna. Alternativt kan ni använda den generella dokumentmallen.

Den tekniska dokumentationen ska vara version 1.0. Den ska alltså granskas noga av er innan ni lämnar in den.
Vi vill att den tekniska dokumentationen ska bestå av ett enda sammanhållet dokument och att ni levererar det till oss elektroniskt i en enda pdf-fil.

Dokumentationen kommer att kommenteras av beställaren efter er presentation.

Exempel på innehåll

1. Inledning
   Bakgrund och syfte.
2. Produkten
   En bild på produkten och en beskrivning av hur den fungerar.
   Beskriv vad den används till.
3. Teori
   Beskrivning av regleralgoritmer mm.
4. Systemet
   Ett översiktligt blockschema och en beskrivning av hela systemet.
5. Modulerna
   Innehåller mera detaljerade blockschemor och beskrivningar av varje modul.
   Tänk på läsbarheten och växla mellan figurer och text.
6. Slutsatser
   Vad är de huvudsakliga bidragen?
   Vilka förbättringar skulle kunna göras?
7. Referenser

1. Kopplingsschema
2. Exempelkod, någon sida från varje modul, så att vi kan bedöma kodens läsbarhet mm och eventuell VHDL-kod
3. Övrigt

Kopplingsschma

- Alla pinnar ska numreras
- Samtliga signaler ska markeras med namn
- Komponenter ska numreras så att de enkelt hittas i komponentförteckningen

Exempelkod

1. programmet ska vara rikligt kommenterat
2. koden ska innehålla namn på programmeraren, datum och version
3. använd gärna programhuvud med förklarande rubriker för de olika rutinerna

Tänk också på

Ange på framsidan vilken produkt som har dokumenterats. Ha gärna en bild på produkten på framsidan.
Figurer ska ha figurnummer och figurtext och de ska refereras till från texten.
Börja alltid ett nytt kapitel med en text (ej en bild).

Användarhandledning

Användarhandledningen ska innehålla en beskrivning av hur produkten används. Utgå från en LIPS-mall. Ha gärna med bilder på produkten både på framsidan och inne i dokumentet. Bilder och beskrivningar på användargränssnitt ska också ingå.