Difference between revisions of "Documentation"
| Line 8: | Line 8: | ||
The process of writing documentation of the work while using the EUDP method. | The process of writing documentation of the work while using the EUDP method. | ||
| + | |||
| + | [[File:TaskOutline.png|500px|EUDP Task Outline]] | ||
== How == | == How == | ||
| Line 25: | Line 27: | ||
== Why == | == 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 likewise important as the documentation of the product it self. 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. EUDP describes an engineering development method. | ||
| + | |||
| + | === 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 == | == Example == | ||
Revision as of 12:03, 19 May 2010
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 likewise important as the documentation of the product it self. 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. EUDP describes an engineering development method.
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
