dokumentation och presentation av ert arbete · 2017-08-31 · dagens föreläsning • första...
TRANSCRIPT
![Page 1: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/1.jpg)
Dokumentation och presentation av ert arbeteDaniel Axehill
ReglerteknikLinköpings universitet
![Page 2: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/2.jpg)
Dagens föreläsning• Första timmen
– Kursens mål.
– Projektmodellen LIPS och dess användning i kursen.
– Olika former av redovisning av ert arbete.
– Allmänna tips och kommentarer.
• Andra timmen
– Jan Palmqvist, f.d. projektledare för Gripen-projektet på SAAB talar om att arbeta i projekt.
![Page 3: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/3.jpg)
Kursens mål1. Lära sig jobba i projekt
– Projektroller.
– Grundläggande insikt i en projektmodell: LIPS.
– Samarbeta i en grupp.
2. Tillämpa sina ämneskunskaper
– Hur kan ni utnyttja teorin ni har lärt er i praktiken?
– Att lösa problem i praktiken kräver ofta viss improvisation…
3. Ha kul!
![Page 4: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/4.jpg)
Organisation av projekten (repetition)
Beställare
Projektledare
Projekt-medlemmar
Handledare
ExpertExpertExpertExpert
Kund
•Studenter
•Lärare
•Extern personal
Examinator
![Page 5: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/5.jpg)
Projektroller• Obligatoriska roller
– Projektledare: leder projektet och gruppen, ansvarar för att målet nås.
– Dokumentansvarig: ansv. för att dokumenten finns och blir klara i tid.
– Testansvarig: planerar tester, ansv. för testplan och testprotokoll, mm.
– Designansvarig: lägger upp riktlinjer för design, sammankallar komponentansvariga.
– Mjukvaruansvarig: ansv. för att koden följer anvisad kodstandard, är välstrukturerad, versionshanterad och dokumenterad/kommenterad.
![Page 6: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/6.jpg)
Projektroller, forts.• Frivilliga roller
– Komponentansvarig: ansv. för vissa komponenters design (motorstyrning, SLAM, etc.).
– Leveransansvarig: ansvarar för leveransen; vad och hur?
– Informationsansvarig: ansv. för hemsida, film, presentation, mm.
• Information om projektroller finns på kurshemsidan och i boken Projektmodellen LIPS.
![Page 7: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/7.jpg)
Projektfaser
Ca 19 dec
Leveransca 5 dec
Ca 11 veckor
Planering Utförande Avslut
Det
aljn
ivå
BP:
Faser:
BP2: Efter 3 veckor
![Page 8: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/8.jpg)
Beslutspunkter• Beställaren fattar beslut om projektets fortsättning
baserat på underlag från projektledare/projektgrupp
• Enligt LIPS-modellen
• BP2
– Här tas beslut om att starta utförandefasen av projektet.
– Underlag: Kravspecifikation, projektplan inklusive tidsplan och systemskiss.
![Page 9: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/9.jpg)
Beslutspunkter, forts.• BP3
– Här tas beslut om detaljerad design och hur kraven ska testas.
– Underlag: Designspecifikation och testplan.
• BP5
– Här fattas beslut om att projektet är redo för leverans. BP5 hålls således strax innan leverans.
– Underlag: All funktionalitet, testprotokoll, användarhandledning och föredrag där det visas att de viktigaste delarna av kravspecifikationen är uppfyllda.
![Page 10: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/10.jpg)
Beslutspunkter, forts.• BP6 (precis innan projektkonferensen)
– Här fattas beslut om att avsluta projektet.
– Här levereras: teknisk rapport, efterstudie med uppföljning av resultat och använd tid, poster, hemsida och demofilm.
![Page 11: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/11.jpg)
Verktyg för projekthantering• LIPS-hemsidan (länk från kurshemsidan) har Word-
och Excel-mallar för projektplanering och uppföljning.
• Även LaTeX kan användas av de som önskar, dock inte samma utbud av färdiga mallar. Se hemsidan.
![Page 12: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/12.jpg)
Granskning av rapporter• Alla rapporter/dokument godkänns av beställaren
• Tekniska rapporter itereras med handledare innan de skickas till beställaren:
– enkel systemskiss
– enkel testplan
– designspecifikation
– testprotokoll
– användarhandledning
– teknisk rapport
![Page 13: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/13.jpg)
Teknisk rapport• Varför?
– Utförlig dokumentation av arbetet.
• Beskrivning av uppgifter och specifikationer.
• Vilka mål nåddes, vilka inte, varför.
• Misslyckade ansatser samt förklaring till varför de inte fungerade.
• Metoder som har använts för att lösa uppgiften.
• Resultat.
![Page 14: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/14.jpg)
Teknisk rapport, forts.• Se gärna tidigare års rapporter!
• Skrivs i Word/OpenOffice eller LaTeX.
![Page 15: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/15.jpg)
Poster• Varför?
– Ett vanligt sätt att presentera ett arbete på (t.ex. på konferenser).
– Ett bra sätt att förklara något på kort tid.
– Mer personligt än ”vanlig muntlig presentation”.
![Page 16: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/16.jpg)
Poster, forts.• Att tänka på vid design
– Inte för mycket text.
• Ska gå att förstå i stora drag utan att någon står vid den…
• …men, i princip ska det krävas någon som presenterar.
– Ska ”locka” folk, uppmuntra till frågor.
– Ska vara lätt att förstå.
– En bild säger ofta mer än många ekvationer.
![Page 17: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/17.jpg)
Poster, forts.• Se Reglertekniks korridor!
• Görs i valfritt program. LaTeX ett alternativ.
![Page 18: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/18.jpg)
![Page 19: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/19.jpg)
![Page 20: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/20.jpg)
Tryck av poster• Format: A1.
• Beställning sker genom Beställaren som vill ha postern i PDF-format i god tid(ca en vecka innan BP6).
• Skrivs ut av beställaren på LiU-Tryck, betalas av Reglerteknik.
• Tekniska detaljer: Handledare
![Page 21: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/21.jpg)
Webbsida• Varför?
– Ett bra sätt att presentera sitt företag och sina produkter med inriktning mot olika målgrupper.
– Interaktiv. Olika typer av medier kan användas.
– Lätt att underhålla, kan finnas tillgänglig under lång tid.
– Mycket stor spridning.
![Page 22: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/22.jpg)
Webbsida, forts.• Läggs upp på ISY:s webbplats, se instruktioner från
Beställaren.
• Görs i valfritt program, måste dock fungera på ISY:sserver.
• Bra om den uppdateras löpande under projektet.
![Page 23: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/23.jpg)
Demofilm• Varför?
– Modernt sätt att förmedla sitt budskap.
– Kan få liknande effekt som en posterpresentation, men det behövs ingen presentatör.
– Möjliggör en ”häftig” och säljande presentation.
– Får mycket bra potentiell spridning om den publiceras på Youtube.
![Page 24: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/24.jpg)
Demofilm, forts.• Använd kamera från någon projektmedlem (om
ingen har, så får vi försöka lösa det).
• Editera med t.ex. Windows Live Movie Maker, iMovie,...
• Ska godkännas av beställaren innan den publiceras på Youtube. Respektera copyright på ev. musik etc.
![Page 25: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/25.jpg)
Muntlig presentation• Varför?
– Möjliggör en ganska detaljerad presentation på ett för åhörarna smidigt sätt.
– Frågor kan besvaras direkt.
– Når oftast fler samtidiga åhörare än en posterpresentation.
![Page 26: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/26.jpg)
Muntlig presentation, forts.• I den här kursen
– Ges vid leveransen (och ev. vid BP5).
– Saklig och korrekt, men ändå säljande presentation.
– Kort beskriva systemet, dess prestanda (speciellt kravställd prestanda), samt de viktigaste tekniska lösningarna ni har använt för att uppnå kraven.
– Tala inte om lösningar som inte har fungerat.
– Endast några få personer bör tala, blir annars rörigt.
![Page 27: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/27.jpg)
Målgrupper• Teknisk rapport
– Vänder sig ofta till personer som redan är intresserade. Typiskt, de som vill lösa liknande tekniska problem.
• Poster– Vänder sig till de som vill köpa en produkt eller lösa
ett liknande tekniskt problem.
• Webbsida– Vänder sig till de som vill investera i ett företag, vill
köpa en produkt eller vill lösa ett liknande problem.
![Page 28: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/28.jpg)
Målgrupper, forts.• Demofilm
– Som för webbsida. Kan göras mycket ”lockande”. Mycket av det ni ska göra är ”häftigt”!
• Presentation– Vänder sig ofta till människor som redan är
intresserade (de har ju kommit). Sammanfattar ofta en rapport.
![Page 29: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/29.jpg)
Efterstudie• Mycket viktigt dokument!
• Analysera hur projektarbetet fungerade
– Arbetssätt
– Samarbete
– Arbetsfördelning
– Hur fungerade beställare/kund?
– Önskemål om någon förändring till kommande år?
![Page 30: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/30.jpg)
Kodstandard och dokumentation av kod• All ny (C++, Python och Java) kod ska följa Googles
kodstandard. Se nätet!
• All ny kod ska kommenteras och dokumenteras med t.ex. Doxygen.
• Det kommer med stor säkerhet finnas både mjuk-och hårdvaruproblem då ni är ”klara”. Dokumentera dessa för kommande grupper!
• Lämna koden som ni själva skulle velat ha fått den!
![Page 31: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/31.jpg)
Versionshanteringsverktyg: Git• I årets kurs går vi över från SVN till Git (GitLab).
• Dokumentation och länk till inloggning finns på:
http://www.ida.liu.se/gitlab/
• Beställaren ger er rättigheter till respektive grupps repository.
• Ev. kan det krävas att ni loggar in och ut från GitLaben gång (om ni inte använt det innan) innan rättigheterna kan sättas.
![Page 32: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/32.jpg)
Några viktiga lärdomar från tidigare år• Hårdvara är ofta orsak till ev. problem, verifiera
funktionalitet snarast. Lita inte på att den fungerar!
– Provkör systemet innan skrivandet av kravspecifikationen.
• Sätt er tidigt in i koden och läs igenom dokumentationen.
• Planera klasser och skriv deras header-filer tidigt!
• Det kan vara svårt att planera i detalj tidigt. Gör en lagom grov planering och förfina efter hand!
![Page 33: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/33.jpg)
Några viktiga lärdomar från tidigare år, forts.• Tänk kritiskt! Fungerar det verkligen, eller hade vi
bara tur?
• Identifiera flaskhalsar/delade resurser och schemalägg smart.
![Page 34: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/34.jpg)
Kursavslutning• Projektkonferens
– Preliminärt kl. 13-16 den 19/12 i Visionen.
– Genomgång av efterstudie
– Posterpresentationer för gruppen och externa gäster.
– Tårta.
Obligatorisk närvaro!Lägg in preliminärt i er kalender redan nu!
![Page 35: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/35.jpg)
Ansvar gentemot gruppen• Diskutera inom gruppen för att formulera
gemensamma mål.
• Kan du inte utföra din uppgift för att den är för stor, du har blivit sjuk, du är tvungen att göra en labb…
– Säg till projektledaren direkt!
• Ha alltid gruppens bästa i åtanke!
![Page 36: Dokumentation och presentation av ert arbete · 2017-08-31 · Dagens föreläsning • Första timmen – Kursens mål. – Projektmodellen LIPS och dess användning i kursen. –](https://reader033.vdocuments.pub/reader033/viewer/2022041723/5e4fbb6fec44591fb67e11f8/html5/thumbnails/36.jpg)
Feedback• Om ni är missnöjda, nöjda eller bara vill diskutera
något angående kursen, prata med mig!
• Det är inte ovanligt med konflikter under ett projektarbete. Om det uppstår, diskutera gärna med handledare, beställare eller mig.