Home > Articles > Software Development & Management

  • Print
  • + Share This
This chapter is from the book

2. The Beauty of Simplicity

Problem

How can you prevent your framework from becoming unmanageable?

Context

You have come to the conclusion that building a framework in your project is justified. Several applications are going to be developed and it’s clear that they will benefit from the framework. You are now in discussions with the potential framework users about what functionality the framework should cover.

Forces

Obviously, the application development teams will come up with requirements for the framework. After all, they are supposed to use the framework, so the framework better meet the requirements they have. However, application developers are sometimes inclined to place more and more requirements on the framework; greater functionality offered by the framework means more time and effort the application development teams can save.

Moreover, framework developers sometimes flirt with wanting to build the perfect framework. Just one more abstraction here, and another generic parameter there, and the framework can grow incredibly powerful.

All these things easily lead to the framework’s architecture becoming rather complex. However, there is much danger in complexity.

First, a complex architecture is difficult to build, maintain, understand, and use. Excessively complex frameworks can therefore create a challenge for designers and users alike, perhaps more of a challenge than they can meet.

Second, complexity, in the context of framework development, often means additional abstractions that are often reflected by generic algorithms and data structures. Genericity, however, is often the enemy of efficiency, and too many abstractions can easily lead you into efficiency problems you cannot resolve.

Third, the more complex the framework is, the longer it takes to build it. If the framework is supposed to "solve all problems on earth," it won’t be available anytime soon.

This, however, is unacceptable. You don’t have much time to build your framework. The teams that build the applications rely on the framework, and they won’t be willing to wait for you. A specification of the framework has to be available when the other teams start designing, and a first version of the framework has to be completed before the other teams start coding. If you don’t manage to get the framework ready in time, this will turn out extremely expensive for the entire project.

And no, you cannot rescue the situation by adding more people to the framework team when the deadline is approaching and the schedule is getting tight. We all know that adding people to a late project makes the project later [Brooks1995].

Solution

Design your framework to be small and to focus on a few concrete tasks.

Try to limit the scope of the framework to what is truly necessary:

  • Focus on a small number of core concepts. Avoid too much abstraction. A framework that embodies too much abstraction tries to do too much and is likely to end up doing little.
  • Perhaps your framework can be a framelet [Pree+1999]. A framelet is a very small framework that defines an abstract architecture that’s not for an entire application but for some well-defined part of an application. It follows the "don’t call us, we’ll call you" principle, but only for that part of the application.

Much in the vein of agile development methods [Ambler2002][Cockburn2002], try "the simplest thing that could possibly work" [Beck2000]. Go with a small solution that works, rather than with a complex solution that promises more than it can deliver.

Examples

The Data Access Layer Framework

When assembling the requirements for the database access framework, the team had to work hard to exclude any application logic from the framework. Many applications were going to use the framework’s versioning features, but all had different ideas on how to use them. The team had to fight to avoid a versioning system that could be used in many different modes. Had the framework team agreed to include all the features that some of the other teams desired, it would have blown up the framework to incredible proportions.

In order to not overcomplicate the framework, the team also had to restrict the mapping of logical entities onto physical tables. Only simple mappings were possible; advanced techniques such as overflow tables had to be left to the applications. Generating the database access functions would otherwise have become unmanageable.

Nonetheless, the data access layer framework did suffer from too much complexity. The composition of business objects from smaller entities turned out to be extremely complicated. The team managed to implement it properly in the end, but only after much unexpected work. In addition, this complexity made the framework more difficult to use than had been intended. Looking back, the team felt the framework should have done without this mechanism, which required much effort and did little good.

To summarize, the team was successful in keeping the framework simple in many instances but felt they should have made simplicity an even more important issue.

The Web Portal Framework

Providing a portal infrastructure is a concrete task, and certainly one that can be addressed by a framework. Like so many other frameworks, however, this Web portal framework suffered from becoming too powerful and, as a consequence, too complex. For instance, parameters need to be passed between the Web browser and the applications running on the mainframe, and the framework includes a mechanism that manages parameter passing in an entirely generic way. It’s powerful, but it’s difficult to understand and rather inefficient. A simpler mechanism would have been better.

But there is a success story as well. The framework wasn’t only supposed to provide an infrastructure for the Web portal; it was also supposed to provide one for integrating Web services (which don’t expect results from the applications to be represented as HTML). The framework team managed to meet these requirements in a simple and elegant way. The framework features a layered architecture: presentation issues are dealt with only in the servlet engine, while use-case management is concentrated on the application server layer. Web services can use the application server layer exactly as the portal does and simply not make use of any HTML generation.

Discussion

Reducing a framework’s complexity is a strategy generally approved of in the literature. For instance, Art Jolin recommends that frameworks be simple and modeless [Jolin1999]. And in our particular context—time constraints along with framework and application development happening simultaneously—keeping the framework simple was crucial.

Simplicity also contributes to longevity. For instance, Brian Foote and Joseph Yoder propose The Selfish Class [Foote+1998]—a class that represents an artifact that reliably solves a useful problem in a direct and comprehensible fashion. In a similar vein, a framework that focuses on a set of core abstractions has a relatively high ability to evolve gracefully and therefore stands the best chance for longevity [Foote+1996].

In order to keep the framework simple as the project goes on, you must be careful with change requests that other teams might have, as they might introduce more, and unwanted, complexity. As a general rule of thumb, only accept Multiple Change Requests (8)—change requests that are made by several, at least two, application development teams.

And of course a Skilled Team (3) is critical to keeping the framework simple. Framework development requires a team that is aware of the problems complexity brings and that is able to see the beauty of simplicity.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020