Object Oriented Software Engineering   View all facts   Glossary   Help
subject > representation > documentation
Next representationlanguage    Uprepresentation    Previous representationdocument   

documentation
subjectfact 
documentationcan be a source of rigidity in software development unless it is managed appropriately2001-08-30 14:55:21.0
can entrench poorly made decisions that are hard to change2001-08-30 14:55:21.0
can waste resources if it is never read2001-08-30 14:55:21.0
has purpose to document decisions and to communicate them to others2001-08-30 14:55:21.0
includes requirements, designs, user documentation, instructions for testers and project plans2001-08-30 14:55:21.0
is a subtopic of 1.8 - The Eight Themes Emphasized in this Book2001-08-30 14:55:21.0
is a kind of representation2001-08-30 14:55:21.0
must provide the information the readers will need, and must be organized in a way so that the readers can find what they need easily2001-08-30 14:55:21.0
should adhere to standards for the company2001-08-30 14:55:21.0
should be as short and succinct as possible2001-08-30 14:55:21.0
should be written at all stages of development2001-08-30 14:55:22.0
should not be written prematurely just to meet specific deadlines because writing documents then becomes the objective, instead of solving problems2001-08-30 14:55:22.0
will not be read if it is excessively voluminous, poorly written or not made readily available2001-08-30 14:55:22.0