Top-Down Design — an Approach for Flawless Software Design and Implementation
Find out more!
Join the DZone community and get the full member experience.Join For Free
You may also like: Software Design Principles
In software development, you would have read in many articles and books that the design should be a top priority. A good design would resolve many issues. The design will bring in more clarity to the developers. It will give granular details on the exact requirements. In this article, I am going to discuss the Top-Down Design approach. I will explain step by step by taking an example of eLearning.
A problem must be viewed at multiple levels. Each one of them has its benefits. The different levels in software design or development are as follows
- Big Picture or a Theme.
- Sub Modules/Subsystems.
- Sub features.
- Business Rules.
In the big picture, it is a kind of a business goal. It is important point back to business goals. Ultimately, all we do is for better business goals. So it will take a higher priority. All decisions that you take down the line must be mapped back to business goals. To understand top-down design, let’s take an example and do a deep dive.
I am from an eLearning domain background. It would be easy for me to relate to the design process. In an eLearning application, generating progress reports for students can be a theme of requirement.
Fair enough however what kind of progress reports are required for these students. It will take you to the next level.
The type of reports will initiate you define the modules.
Defining the type of reports at a broader level constitutes the Modules' definition. The modules are identified as
- Instructor Reports.
- Student Reports.
Once you define the broader modules, we have to define sub modules for these identified modules
Let’s take up the modules and identify the possible submodules.
Instructor Reports — Module
- Course report.
- Assignment wise Report.
- Student wise Report.
- Result report.
Student Reports — Module
- Course wise Report.
- Assignment wise report.
Once we identify the submodules, detail it with the list of features. A few examples are:
- Course Report
- The Instructor should be able to generate a report for one or more courses.
- It should have the flexibility to select a date range.
- It should give results for all students in a course along with the Exams list as a full view option.
- Assignment Report
- Users should be select one or more assignments.
- Users should be able to get the report by date range.
- Assignment report for one specific course or multiple courses.
The features can be broken down into sub-feature as well.
Use Cases and Business Rules
For these types of reports, we need to identify business entities. Here, in this case, the business entities would be:
These entities will help to design API. Your API should be designed based on entities of a domain.
They will also help us to identify the systems and subsystems. For example, in the above list user, course, exams, grades are all different systems on their own. Reports modules will have to interact with all these systems to get the data required for the report.
Once we have defined all the steps explained above, it is time to dig deeper into the feature and sub-feature more in-depth.
We must come up with a list of business rules for each feature or sub-feature. It must list the exact list of business rules must be achieved as part of a feature.
It will be a checklist for developers and testers for executing their tasks. A developer will ensure all those business rules are implemented for that use case. It will ensure there are no bugs related to business rules and it is one of the most important parts of the development. Testers will design test cases considering the user cases and business rules.
Once we have identified and done a deep dive of functional requirements with the help of top-down design. It is important to consider non-functional requirements like security and performance as well at each stage. It will ensure the system designed performs at higher load or required load and secure.
An example would be the report generation for students. It is important to understand the number of students in a course. That the system will be able to generate a report for the number of students in a course. In the case of self-learning and students can enroll do self-registration to a course.
The total number of users is can grow as big as 3000 to 5000. It will give you a nonfunctional requirement. It will help you to identify the measures must be taken to support such a big expectation. It must be handled at the design phase so that the implementation is done correctly and performs as expected.
The requirement of the user’s personally identifiable information should be fetched from another system. Here again, a nonfunctional requirement of security and performance are in the scope.
To design a system to support all these cases requires sufficient time. We must identify these nonfunctional requirements as part of your top-down design. It will help you to come up with the right estimate as well.
Benefits of Top-Down Design
- It helps to identify systems and subsystems.
- Bring in more clarity on communication between two systems or subsystems.
- Comprehensive list of features and sub-features along with all business rules.
- No room for mistakes in implementing user requirements. High quality can be achieved.
- Ensure to arrive at a correct estimate.
- Easy to code as we have clearly defined expectations at all levels.
- Nonfunctional will help to make sure it performs, secured.
Opinions expressed by DZone contributors are their own.