Talk:Documentation

From EUDP
Jump to: navigation, search

Notes for further editing

Place holder for thoughts.


Notes to remember when revising the pages

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

Remember that requirements, the architecture and other found in the Launch phase is what is going to implemented. A good idea is to refer back to the requirements, when during Realisation the specific requirement is selected for implementation. If the requirements are refined or even changed, because of deeper knowledge of the system-to-be, ensure, that the customer accepts this in writing or by signature - before rushing to implementation of the changed requirement.

Don't let things go into this:

Arnold's Laws of Documentation:
	(1) If it should exist, it doesn't.
	(2) If it does exist, it's out of date.
	(3) Only documentation for useless programs transcends the
	    first two laws.

In the Use Case Analysis the involved objects/classes must be identified for each use case after the analysis and an updated SOD/Class diagram is the resulting artefact.

Identify the objects/classes involved after performing the Interface Analysis