|
|
|
|
| Re: Design Document for stored procedure [message #316943 is a reply to message #316868] |
Mon, 28 April 2008 22:15   |
rleishman
Messages: 3728
Registered: October 2005
Location: Melbourne, Australia
|
Senior Member |
|
|
There are two components to good technical documentation:
- High Level Design
- Detailed Design
This supposes that we have already done the Business Requirements (what the users want to be able to achieve), the Functional Requirements (what the Business Analyst wants the system to achieve), and the Functional Specification (what the Application Architect / System Analyst claims the system will do).
So, given a Functional Specification (which tells you what the system must do), you need to determine how the system will do it.
"It" may require a number of independent data modules (files, tables) and code modules - some single-purose, some shareable. The High-Level Design must:- Identify and describe each of these modules
- Identify the technology of each module (eg. Stored Procedure, Java)
- Identify dependencies, data flows, and control flows between them
- Trace each component back to the Functional Specification
Diagrams are good for this.
Then comes the Detailed Design. Each module from the High-Level Design is describes in more detail. For tables, show the volumetrics, growth, indexes, tablespace - everything needed to implement the table. For code modules, identify inputs and outputs; overall algorithm; pseudocode for any complex algorithms or calculations; library routines that should be re-used rather than re-coded.
Importantly, the High Level Design will identify a module and tell you WHAT it does; the Detail Design will tell you HOW is does it.
Ross Leishman
|
|
|
|
|
|
|
|
|
|
] 
Blog
Search
Help
Members
Register
Login
Home
