The Next milestone - Project Design

We need to finish the project design by this Tuesday. Here's what we've gotta include in it -
  • Introduction
  • Solution Overview
  • Architectural Strategies
  • System Architecture
  • Detailed System Design
Classification
The kind of component, such as a subsystem, module, class, package, function, file, etc. ....
Definition
The specific purpose and semantic meaning of the component. This may need to refer back to the requirements specification.
Responsibilities
The primary responsibilities and/or behavior of this component. What does this component accomplish? What roles does it play? What kinds of services does it provide to its clients? For some components, this may need to refer back to the requirements specification.
Constraints
Any relevant assumptions, limitations, or constraints for this component. This can be derived from the Constraints section of the Project Planning template. However, you will have to map the constraints from that document to the exact module that is implementing or is being affected by the constraint.
Composition
A description of the use and meaning of the subcomponents that are a part of this component.
Uses/Interactions
Include the other components that his module interacts with and the components that this module is used by. Object-oriented designs should include a description of any known or anticipated subclasses, superclasses, and metaclasses.
Resources
A description of any and all resources that are managed, affected, or needed by this module such as memory, processors, printers, databases, or a software library.
Processing
A description of precisely how this components goes about performing the duties necessary to fulfill its responsibilities. This should encompass a description of any algorithms used; changes of state; relevant time or space complexity; concurrency; methods of creation, initialization, and cleanup; and handling of exceptional conditions.
Interfaces
The set of interfaces/services (resources, data, types, constants, subroutines, and exceptions) that are provided by this component. The precise definition or declaration of each such element should be present, along with comments or annotations describing the meanings of values, parameters, etc. .... This section can be provided in the code itself by providing adequate comments in the code. An advantage of providing this in the code is that most of the latest IDEs are able to use these comments to generate documentation files/help files saving the developer the trouble of developing and managing this.
Glossary
An ordered list of defined terms and concepts used throughout the document.
I think going through each part one by one would be great. So, lets have some discussion over the "Solution Overview" in next post...

0 comments:

Post a Comment