Projektdokument
Under projektets gång ska gruppen producera ett antal dokument. LIPS-boken innehåller instruktioner och mallar för dessa dokument. Mallarna finns också tillgängliga i elektronisk form på på nätet: LIPS-mallar
All producerad dokumentation ska lämnas in i projektgruppens repositorium i Gitlab, i underkatalogen docs. Efter inlämning noteras berörd part (beställare eller handledare, beroende på dokument) via Teams eller mail.
- Kravspecifikation
Här definieras vad som ska konstrueras i ert projekt. Varje grupp skriver en egen kravspecifikation med projektdirektivet som utgangspunkt. Kravspecifikationen ska godkännas av beställaren. Efter godkännandet får kravspecifikationen inte ändras utan beställarens medgivande. - Systemskiss
Systemskissen ska innehålla en översiktlig beskrivning av hur ni tänker konstruera er produkt. Skissen används för att avgöra vilka moduler som konstruktionen innehaller och hur konstruktionen av dessa kan delas in i arbetsblock. Skissen ska bland annat innehålla ett blockschema (använd LIPS generella dokumentmall för detta dokument) - Projekt- och tidplan
Projektplanen beskriver hur projektet ska utföras och villkoren för ert samarbete. Här planerar ni tidsåtgången för de olika arbetsblocken och vem som ska jobba med vad och när. Mall för projektplan - Designspecifikation
Detta är en förfining av systemskissen som mer i detalj visar hur er produkt ska konstrueras. Här finns kretsscheman och flödesscheman tillsammans med en beskrivning av konstruktionen. Då designspecifikationen är godkänd av handledaren får ni tillgang till en labplats i MUXEN. Checklista för designspecifikation - Teknisk dokumentation och användarhandledning
Den tekniska dokumentation ska beskriva hur produkten är konstruerad och användarhandledningen ska beskriva hur produkten används. Detta ska vara två olika dokument. Mer information finns nedan. - Efterstudie
I detta dokument sammanställer projektgruppen sina erfarenheter av arbetssätt, samarbete och användandet av projektmodellen. Mall för efterstudie.
Tidrapportering
Tidplanen ska löpande uppdateras under projektets gång. Allt arbete i projektet efter beslutspunkt 2 ska tidsredovisas varje vecka i HT2. Arbetad tid redovisas veckovis på flik två i tidplaneringsarket.
Tidplanen ska modifieras de veckor då arbetad tid inte stämmer med planerad tid. Tidrapporten tillsammans med den uppdaterade tidplanen skickas, i Excel-format, till den person som är beställare för ert projekt. Se Leveranser och Deadlines för mer detaljer.
Statusrapport
Vid begäran från beställaren ska gruppen skicka in en statusrapport.
Teknisk dokumentation
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 sammanhållet dokument och att ni levererar det till oss elektroniskt i en 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
Vilka förbättringar skulle kunna göras? - Referenser
- Appendix
- A. Kopplingsschema
- B. Eventuella programflödesschemor
- C. Övrigt
Angående bilagor
Kopplingsschema:- Alla pinnar ska numreras
- Samtliga signaler ska markeras med namn
- Komponenter ska numreras så att de enkelt hittas i komponentförteckningen
- Programmet ska vara rikligt kommenterat
- Använd gärna programhuvud med förklarande rubriker för de olika rutinerna
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å.
Ha gärna i åtanke att läsare av en användarhandledning inte nödvändigtvis har lika gedigen teknisk bakgrund av produkten som konstruktören har.
Informationsansvarig: Anders Nilsson
Senast uppdaterad: 2022-09-27