Documentation
Contents
P R E L I M I N A R Y
NOTE: This content is under editing and might not yet reflect the final result.
What
The process of writing documentation of the work while using the EUDP method.
How
The dish
A documentation, that reflects the work that has been performed.
Ingredients
- All phases of the EUDP
Process
Why
Documentation is important in all projects. But there are different requirements to how the documentation is written.
In an education situation, the process - the road the student(s) followed to get to the goal - is as important as the documentation of the product it self are.
On the other hand in a development environment the process it self is less important and the focus is on the documentation of the developed. The documentation must be exactly so complete that it enables a colleague to inherit the project and continue the work. This requires that documentation both describes the developed parts as well as the choices made during the work.
In academic environments the documentation must reflect the way the scientist work: Describe a problem observed, formulate a hypothesis or a problem statement, describe related work, describe the method applied, describe the experiment (collecting data), describe the analysis of the experiments outcome, and finally draw the conclusions and putting the work into perspective. The academic work may be iterative going through the described phases several times refining the problem statement, adjusting the experiment, etc. until it reflect the observed problem.
EUDP describes an engineering development method. EUDP can be, and are, used in education environments. In EUDP is only described how the documentation should be when applied at universities.
Process Documentation
The process documentation documents the work that brought the developer to the goal rather than the product it self.
It is important for the students mentor can see how the development process is applied.
Product Documentation
The product documentation documents the construction, the developer has created.
Example
Notes for further editing
Develop a System Overview Diagram - combine HW-blocks and Classes (SysML could be used).
Rich Picture should in the Launch Phase develop into the System Overview Diagram
