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
- Inledning
Bakgrund och syfte. - Produkten
En bild på produkten och en beskrivning av hur den fungerar.
Beskriv vad den används till. - Teori
Beskrivning av regleralgoritmer mm. - Systemet
Ett översiktligt blockschema och en beskrivning av hela systemet. - Modulerna
Innehåller mera detaljerade blockschemor och beskrivningar av varje modul.
Tänk på läsbarheten och växla mellan figurer och text. - Slutsatser
Vad är de huvudsakliga bidragen?
Vilka förbättringar skulle kunna göras? - Referenser
- Kopplingsschema
- Exempelkod, någon sida från varje modul, så att vi kan bedöma kodens läsbarhet mm och eventuell VHDL-kod
- Övrigt
Kopplingsschma
- Alla pinnar ska numreras
- Samtliga signaler ska markeras med namn
- Komponenter ska numreras så att de enkelt hittas i
komponentförteckningen
Exempelkod
- programmet ska vara rikligt kommenterat
- koden ska innehålla namn på programmeraren, datum och version
- 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å.
TSEA56 - Kandidatprojekt i elektronik
- Bokning av Visionen
- Etik
- Filmklipp
- Framläggning
- Föreläsningar
- Förstudie (skrivuppgift)
- Kandidatrapport (kappa)
- Kursens bibliotekssida
- Kursinformation
- Kursmaterial
- Kursplan
- Labanmälan
- Laborationer
- Leveranser
- LIPS-mallar
- Lisam
- Personal
- Projektarbete
- Projektdirektiv
- Projektgrupper
- Schema
- Skriftlig kommunikation
- Teknisk dokumentation och användarhandledning
- Tävlingsschema 2022
- Vanheden
Informationsansvarig: Mattias Krysander
Senast uppdaterad: 2021-05-03