Documenting a Complete Java Application Using OPEN, Volume 1Based on a hands-on training course, Documenting a Complete Java Application Using OPEN provides a reference for the entire object-oriented development process from beginning to end, from requirements through design and implementation to testing. Aimed at developers new to object-oriented technology, the example application - a vending machine - has been specifically developed to illustrate a wide range of potentially problematical circumstances that might be encountered by any software engineer. The documentation of the example included in the book provides a format that any software engineer may follow to document his/her own software, together with advice on what information should be included and what may be excluded given time and resource constraints. |
Contents
68 | 2 |
Design documentation | 3 |
Objectoriented documentation for the Mark I Vending Machine MIVM | 47 |
Copyright | |
9 other sections not shown
Common terms and phrases
1A item 2B item display Alternative Path bill validator Blackbox sequence diagram client coin dispenser assembly collaboration diagram contains 2 quarters context diagram currentModeProxy custom operating system Customer Selects customer's credit customer's selection customOperatingSystemCalls Dime dispenser proxy Dispense Item dispenser proxy contains Display History display proxy displays document Domain-specific Door switch external Figure hardware implementation interactions invokes item dispenser assembly item dispenser proxy item display proxy layer letter selection button Machine Software main display displays main display proxy messages MIVM is Dispense mode button models Nickel dispenser proxy notifies number selection button object package diagram postconditions Precondition Primary Path proxy displays 2B proxy is empty public void Quarter dispenser proxy refund button relationships represented in COMN reset selected column selected(aLetter selected(anInteger Selects the Column sends server Service Representative Selects Set Price Smalltalk solenoid stepper motor submode Superclass SYS-D SYS-R system context diagram Valid Coin vending machine Whitebox sequence diagram