README.md 6.17 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
10
11
12
13
14
15
## Statements
Grady Booch:
“People are more important than any process. Good people with a good process will outperform good people with no process any time.”

Martin Fowler:
“You should use iterative development only on projects that you want to succeed” 

16
## Overvej:
17
- Litteratursøgning
18
- Risikoanalyse
19
20
- SWAT analyse (kan i nogle tilfælde være sundt at udføre)
- Interessent analyse (specielt ved eksterne projekter)
21

22
## Guides
23
- [ASE Projektvejledninger (kræver VPN eller på AU!))](http://studerende.au.dk/studier/fagportaler/diplomingenioer/undervisningdiplom/projektvejledning-katrinebjerg/)
24
- [SCRUM notes](./Notes/Scrum.pdf)
25
- [Use Case Notes](./UseCases)
26
27
- [Project Templates](./Templates)
- [Scientific Methods](Theory/scientific_methods.md)
28

29
30
31
32
## 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/)
33
34
- [Clean Code, Robert C Martin (Mega gode principper)](https://www.pearson.com/us/higher-education/program/Martin-Clean-Code-A-Handbook-of-Agile-Software-Craftsmanship/PGM63937.html)
  - [Clean Code by Robert C. Martin(youtube)](https://www.youtube.com/watch?v=7EmboKQH8lM)
35
    - Hvis ikke du har tid til at høre det hele (det burde du have ;-) ), kan det anbefales at høre fra @24:30 og frem til @32:30
36
- [SOLID Principles, Robert C. Martin](http://principles-wiki.net/collections:robert_c._martin_s_principle_collection) 
37
- [CoffeeMaker - Something about software design :-), Robert C. Martin aka _Uncle Bob_](./Articles/CoffeeMaker.pdf)
38
39
- ["The 4+1 View Model of Architecture", Philip Kruchten](https://www.researchgate.net/publication/220018231_The_41_View_Model_of_Architecture)

40
## Useful information about proper scientific writing
41
- [AU Studypedia](http://studypedia.au.dk)
42
43
- [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/)
44
45
- [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)
46
47

# Forslag til indhold af Projekt- og procesrapport
48
Skabelonen er tænkt som et udgangspunkt og kan justeres efter behov afhængigt af projektet.
49
50
51

## Projektrapport:
- Forside
52
53
54
55
  - 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
56
- Resumé/Abstract
57
  - _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))
58

59
60
61
62
63
- Indholdsfortegnelse
- Forkortelser/symboler
- Forord
  - _Handler om rapporten!_
  - Hvem er I/ evt. firmasamarbejde
64
  - Læsevejledning ([Eksempel](./Examples/readingguide.md))
65
66
67
68
  - Tak til
    - Hvis I har fået hjælp fra personer/firma
    - Vejleder/andre undervisere
  - Evt. arbejdsfordeling!
69
70
71
72
73
74
- 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
75
  - Rigt billede ([Rige billeder](./Notes/rigebilleder.pdf))/system tegning
76
77
  - Afgrænsning
  - Evt. kort om proces
78
79
- Hovedafsnit
  - Analyser og diskussioner der ligger til grund for de beslutninger der er truffet.
80
81
    - Kravspecifikation/Use Case/funktionelle krav/ikke funktionelle krav
    - MosCoW
82
    - Domæne model ([Domæne modeller](./Notes))
83
84
85
86
87
88
    - Valg af teknologier
    - Beskrivelse af valgte teknologier
  - Arkitektur
  - Design
  - Implementering
- Evaluering/test/resultater
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
- 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:
109
110
111
- CDIO
- SCRUM
-
112

113
114
115
116
117
118
119
120
121
# 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>