Skip to main content

The big three: Flexibility Extensibility Maintainability












[Time: 1 min 45 secs]


As we have said earlier, software is rarely ever made and forgotten. After the release, there will be change requests, there will be requests for new features, and bugs to be fixed. And why after the release, even when we are in the process of making software we have to interact with code that has already been written. It is with the goal of easing all of these, that we design software.

The design should enable flexibility, extensibility, and maintainability.













[Time: 9 mins]



FLEXIBILITY

  • What is flexibility?
  • Actions for change
    • Identify, Change, Test
  • Detractors of flexibility
    • Complex code
    • Lack of clear responsibilities for classes and methods
    • Unreadable code
    • Repetitions in code
    • Uncontained functionality
  • Design decisions that promote flexibility
    • DRY (Don't repeat yourself)
    • KISS (Keep it simple)
    • No tricks
    • Loose coupling
    • Encapsulation
    • Note: Minimize testing












[Time: 6 mins 25 secs]


EXTENSIBILITY

  • What is extensibility
  • Actions for extensions
    • Actions for change, adding classes
  • Detractors of extensibility
    • Same as detractors for flexibility (ideally we want to extend the software by adding new classes and not modifying existing classes)
  • Design decisions that promote extensibility
    • Loose coupling
    • Assigning proper responsibilities
    • Proper use of inheritance and polymorphism
    • Design patterns

MAINTAINABILITY:


  • Maintainability is flexibility + extensibility + bug fixes + refactorings

  • All design idioms for flexibility & extensibility apply to maintaibility also. Besides these design factors, some process factors like having proper test cases, and good documentation also apply. But since we are focussing on design in this section, we will not take any process related issues.
  • Remember "maintainability" is the ultimate goal of software design



Note: This post was originally posted on my blog at http://www.adaptivelearningonline.net
Labels:

Comments

Post a Comment

Popular posts from this blog

Fuctional Programming Principles in Scala - Getting Started

Sometime back I registered for the Functional Programming Principles in Scala , on Coursera. I have been meaning to learn Scala from a while, but have been putting it on the back burner because of other commitments. But  when I saw this course being offered by Martin Odersky, on Coursera , I just had to enroll in it. This course is a 7 week course. I will blog my learning experience and notes here for the next seven weeks (well actually six, since the course started on Sept 18th). The first step was to install the required tools: JDK - Since this is my work machine, I already have a couple of JDK's installed SBT - SBT is the Scala Build Tool. Even though I have not looked into it in detail, it seems like a replacement for Maven. I am sure we will use it for several things, however upto now I only know about two uses for it - to submit assignments (which must be a feature added by the course team), and to start the Scala console. Installed sbt from here , and added the path
1 comment
Read more

Five Reasons Why Your Product Needs an Awesome User Guide

Photo Credit: Peter Merholz ( Creative Commons 2.0 SA License ) A user guide is essentially a book-length document containing instructions for installing, using or troubleshooting a hardware or software product. A user guide can be very brief - for example, only 10 or 20 pages or it can be a full-length book of 200 pages or more. -- prismnet.com As engineers, we give a lot of importance to product design, architecture, code quality, and UX. However, when it comes to the user manual, we often only manage to pay lip service. This is not good. A usable manual is as important as usable software because it is the first line of help for the user and the first line of customer service for the organization. Any organization that prides itself on great customer service must have an awesome user manual for the product. In the spirit of listicles - here are at least five reasons why you should have an awesome user manual! Enhance User Satisfaction In my fourteen years as a
Post a Comment
Read more

Inheritance vs. composition depending on how much is same and how much differs

I am reading the excellent Django book right now. In the 4th chapter on Django templates , there is an example of includes and inheritance in Django templates. Without going into details about Django templates, the include is very similar to composition where we can include the text of another template for evaluation. Inheritance in Django templates works in a way similar to object inheritance. Django templates can specify certain blocks which can be redefined in subtemplates. The subtemplates use the rest of the parent template as is. Now we have all learned that inheritance is used when we have a is-a relationship between classes, and composition is used when we have a contains-a relationship. This is absolutely right, but while reading about Django templates, I just realized another pattern in these relationships. This is really simple and perhaps many of you may have already have had this insight... We use inheritance when we want to allow reuse of the bulk of one object in other
3 comments
Read more