README.md 5.15 KB
Newer Older
1
# Velkommen
2

3
Formålet med denne side er at præsentere nogle noter, værktøjer, og skabeloner for forskellige projektrapporter. Noten er baseret på mit arbejde som vejleder og censor for en lang række forskellige projekter. Noten er primært rettet mod ingeniørstuderende ved Arhus Universitet, hvor jeg er vejleder på projektet, som skal aflevere en skriftlig projektrapport.
4

5
6
7
God arbejdslyst ;-)

Michael Alrøe
8

9
## Overvej:
10
11
12
13
- Risikoanalyse
- Litteratursøgning
- SWAT analyse (kan i nogle tilfælde være sundt at udføre)
- Interessent analyse (specielt ved eksterne projekter)
14

15
## Guides
16
17
18
19
- [ASE Projektvejledninger](http://studerende.au.dk/studier/fagportaler/diplomingenioer/undervisningdiplom/projektvejledning-katrinebjerg/)
- [SCRUM notes](./Scrum.docx)
- [Project Templates](./Templates)
- [Scientific Methods](Theory/scientific_methods.md)
20

21
22
23
24
## Articles/Papers/Manifests
- [Agile Software Development Manifest](http://agilemanifesto.org/)
  - [12 principles for agile software](http://agilemanifesto.org/principles.html)
- [Extreme Programming](https://ronjeffries.com/xprog/what-is-extreme-programming/)
25
26
- [CoffeeMaker - Something about software design :-)](./CoffeeMaker.pdf)
 
27
## Useful information about proper scientific writing
28
- [AU Studypedia](http://studypedia.au.dk)
29
30
- [God citatskik og plagiat i tekster](http://kum.dk/servicemenu/publikationer/2006/god-citatskik-og-plagiat-i-tekster/)
- [Ophavsret - En mini-guide](http://kum.dk/servicemenu/publikationer/2004/ophavsret---en-mini-guide/)
31
32
- [Stop plagiarism](http://stopplagiat.nu/)
- ["Bachelorprojektet : sådan gør du!", Trine Toft](https://soeg.kb.dk/discovery/fulldisplay?docid=alma99122730995505763&context=L&vid=45KBDK_KGL:KGL)
33
34

# Forslag til indhold af Projekt- og procesrapport
35
Skabelonen er tænkt som et udgangspunkt og kan justeres efter behov afhængigt af projektet.
36
37
38

## Projektrapport:
- Forside
39
40
41
42
  - Titel
  - Subtitel - _kan være en mere beskrivende titel der allerede her præsenterer hvad projektet går ud på samt hvilke teknologier der anvendes. Denne titel kan også bruges ved aflevering til Digital Eksamen!_
  - Navne på studerende og studienumre
  - Navn på vejleder
43
- Resumé/Abstract
44
  - _Et abstract er en kort sammenfatning af hele besvarelsen. Formålet er at give læseren et hurtigt overblik over opgavens indhold (Baggrund, formål/problemstilling, anvendte metoder, resultater og konklusion)_ ([Eksempel](./Examples/abstract.md))
45

46
47
48
49
50
- Indholdsfortegnelse
- Forkortelser/symboler
- Forord
  - _Handler om rapporten!_
  - Hvem er I/ evt. firmasamarbejde
51
  - Læsevejledning ([Eksempel](./Examples/readingguide.md))
52
53
54
55
  - Tak til
    - Hvis I har fået hjælp fra personer/firma
    - Vejleder/andre undervisere
  - Evt. arbejdsfordeling!
56
57
58
59
60
61
- Introduktion/indledning
    - _Handler om produktet!_
    - _Afhandlingen indeholder en klar og præcis problemformulering/projektformulering af et emne som er relevant for uddannelsen, og som giver plads til selvstændige analyser, teoretiseringer og refleksioner._
    - _Besvarelsen er afgrænset således, at afhandlingens analyser og diskussioner er relevante og nødvendige og dækkende for at kunne besvare problemformuleringen. Den studerende viser overblik over det valgte emne ved at begrunde, hvad der er med, og hvad der ikke er med i afhandlingen, vedrørende emner, teorier, metoder og empiri._
  - Beskrivelse af formål
  - Problemformulering/hypotese
62
  - Rigt billede ([Rige billeder](./rigebilleder.pdf))/system tegning
63
64
  - Afgrænsning
  - Evt. kort om proces
65
66
- Hovedafsnit
  - Analyser og diskussioner der ligger til grund for de beslutninger der er truffet.
67
68
    - Kravspecifikation/Use Case/funktionelle krav/ikke funktionelle krav
    - MosCoW
69
    - Domæne model ([Domæne modeller](./DomainModels))
70
71
72
73
74
75
    - Valg af teknologier
    - Beskrivelse af valgte teknologier
  - Arkitektur
  - Design
  - Implementering
- Evaluering/test/resultater
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
- Diskussion
- Konklusion
  - _Afhandlingen indeholder klare konklusioner, der er dokumenteret og underbygget ved de teorier og metoder projektet anvender._
- Fremtidigt arbejde
- Referencer
  - _Problemstillingen analyseres ved inddragelse af relevant litteratur på området i det omfang, det er nødvendigt for en dybdegående analyse af emnet. Argumenter, tolkninger, beskrivelser og data fra andre kilder end den studerendes egne, dokumenteres ved nøjagtige kildehenvisninger._
  - [1] ……………
  - [2]…………….

- Bilag/Appendiks -> .zip fil

Disponering:

- _Afhandlingen er disponeret i en logisk og hensigtsmæssig rækkefølge med en klar rød tråd fra problemformulering til analysen og videre til en konklusion, og hvor hovedvægten er lagt på de dele af analysen, der er afgørende for at besvare problemformuleringen._

Formkrav:

- _Afhandlingen fremstår i et flot og kommunikativt layout og er formuleret på et korrekt, klart og flydende sprog._

## Procesbeskrivelsen/Procesrapport:
96
97
98
- CDIO
- SCRUM
-
99

100
101
102
103
104
105
106
107
108
109
# Tools
Nogle værktøjer der kan bruges i forbindelse med projekter.
- UML diagrams: PlantUML, også som plugin for VSCode!
- Prettier (for VSCode)
- Print: https://kicad.org/
- PCB: https://docs.easyeda.com/en/PCB/Order-PCB
- Git: SmartGit!<br>
- AU's GitLab - specielt i forbindelse med NDA'er/eksterne partnere<br>