design document Comparison Table

Object Oriented Software Engineering View all facts Glossary Help

subject > representation > document > design document

Next document: domain analysis document Up: document Previous document: catalog of reusable components

design document comparison table

Subject make reference to include allow write for force describe have suggested structure have purpose has definition see also contain is a subtopic of ensure is a kind of discuss

document a particular audience Anything written that that describes software 9.6 - Writing a Good Design Document representation

design document the requirements that are being implemented by this design
information that would be readily obvious to a skilled programmer or designer
details in a design document that would be better placed as comments in the code
details that can be extracted automatically from the code, such as the list of public methods
a group of people to review the design and therefore to improve it
Those who will be implementing the design, i.e. the programmers
Those who will need, in the future, to modify the design
Those who need to create systems or subsystems that interface with the system being designed
a designer to be explicit and to consider the important issues before starting implementation what system or part of the system this design document describes
purpose
general priorities
outline of the design
major design issues
other details of the design
to encourage designers to make good design decisions
to communicate the design to others
Documentation produced as a result of the design process design every design decision along with the reasoning that went into making the decision 9.1 - The Process of Design traceability by making reference to the requirements that are being implemented by this design document the important issues that had to be resolved, the possible alternatives that were considered, the final decision and the rationale for the decision

Subject	make reference to	include	allow	write for	force	describe	have suggested structure	have purpose	has definition	see also	contain	is a subtopic of	ensure	is a kind of	discuss
document				a particular audience					Anything written that that describes software			9.6 - Writing a Good Design Document		representation
design document	the requirements that are being implemented by this design	information that would be readily obvious to a skilled programmer or designer details in a design document that would be better placed as comments in the code details that can be extracted automatically from the code, such as the list of public methods	a group of people to review the design and therefore to improve it	Those who will be implementing the design, i.e. the programmers Those who will need, in the future, to modify the design Those who need to create systems or subsystems that interface with the system being designed	a designer to be explicit and to consider the important issues before starting implementation	what system or part of the system this design document describes	purpose general priorities outline of the design major design issues other details of the design	to encourage designers to make good design decisions to communicate the design to others	Documentation produced as a result of the design process	design	every design decision along with the reasoning that went into making the decision	9.1 - The Process of Design	traceability by making reference to the requirements that are being implemented by this design	document	the important issues that had to be resolved, the possible alternatives that were considered, the final decision and the rationale for the decision

Next document: domain analysis document Up: document Previous document: catalog of reusable components