Home > Articles > Software Development & Management

This chapter is from the book

1.3 Developing Frameworks

Developing a framework involves more than just the product (that is, what you are going to ship as part of the framework, its architecture, and how it is factored). It also encompasses the process used to develop the framework (including the evolutionary iterations), the development team and organization that developed it, and the customer using it (including the business models and processes supported by the framework). All of these factors need to be taken into account during framework development and should be captured as part of your development process. Ignoring any of these factors is likely to result in disaster.

Development Process

Developing frameworks is both similar to and different from developing applications. In either case, you should follow a methodical development process (see the Alles in Ordnung pattern, Section 3.1), such as the Unified Software Development Process [Jacobson 99]. A framework goes though each of the stages of methodical software development and will likely require more iterations than an equivalent application development effort.

The first key to successfully developing a framework is deciding what domain (functional models and processes) or domains you want to address and, within that, what applications you want to address. You can say you want a framework that addresses all applications in all domains, but be careful—if you take on too much, you will end up with requirements like "be able to write any business application," which quickly leads you to developing a programming language or a class library. These have value, but to be a framework, or at least a framework of value, the framework needs to be more focused. What about component frameworks like Java 2 Platform Enterprise Edition (J2EE)? Aren't they focused on being able to write any business application? Although they appear to be broadly applicable, these frameworks are actually narrowly targeted and support a specific domain, namely, the domain of distributed software component management.

A factor here is how much time you want to (or can) spend gathering the requirements. In order to develop a framework that addresses a set of applications in a domain (or domains), you need to have requirements from each of these applications (for each domain). Requirements are best gained from experts in the domain, for example, from business analysts for business applications. These domain experts do not have to be technically savvy—that is your technical team's job—but they need to know the applications (or more specifically, the business processes) in the domain (or domains) very well. This is unique to business application frameworks since, when developing most technical frameworks, the developer knows enough (or can quickly learn) about the domain. For example, with our prior engineering experience we could develop a device-management framework, however, we could not develop an accounting application; to do this, we need accountants.

Your process artifacts will vary depending on the development process you use. When developing the IBM SanFrancisco frameworks, we followed a process similar to the Rational Unified Process (which didn't exist at the time). For our process the deliverables were

  • Requirements—a business-level description of what the framework does (what it does, not how it does it)

  • Use cases—the business processes and tasks used to fulfill the requirements

  • Analysis model—the business-level breakdown of the solution into business objects

  • Design model—the design-level breakdown of the solution into classes

  • Source code—the implementation

  • Test cases—including both the business-level description and the code to test the framework code

Each of these artifacts was developed in an iterative fashion. Figure 1.1 shows how they relate to one another and who (technical versus domain experts) is responsible for them.

Figure 1.1Figure 1.1 How deliverables relate to one another and who owns them

These and other deliverables are discussed in detail as part of the Unified Software Development Process [Jacobson 99] and in Appendix B.

An area that becomes challenging in business application or framework development is the split between domain and technical expertise. This split (having two people or groups of people own some of the artifacts) provides two challenges: (1) initially developing the artifacts, since each group will need to participate, and (2) keeping the related artifacts coherent with one another during development iterations. To address these two challenges we add distinct points of contact between the domain and technical teams.

  • Use case handoff—the completed requirements, use cases, and first-pass analysis model are given to the technical team by the domain team. The purpose of this meeting is for the members of the domain team to educate the technical team members so they can begin the design. At this point the technical team works with the domain team to refine the analysis model and begin producing the design model.

  • Combined review—the domain and technical teams review a package consisting of the requirements, use cases, analysis model, design model, and test case definitions. This is to ensure that all of these deliverables are consistent before code development begins. The test cases are usually defined by the domain team from the use cases and then implemented by the technical team.

Within our process, these meetings form the minimum set of interactions the two teams can have.

These interaction points and the systematic development process into which they fit are critical for producing and keeping the artifacts consistent. Why should you care about keeping these internal artifacts consistent? Although they are internal when developing an application, they also become part of a framework's external deliverables. 1 If a framework provided only the code that implemented it, you would be able to map only above the code level once you did a lot of reverse engineering. The learning curve is big enough without that kind of obstacle! As discussed in the next section, the sooner the framework

Another aspect of developing a framework is maintenance. Once the framework is developed, it will need to be maintained. The increased number of artifacts is both a blessing and a curse. It is a curse because you have more to maintain. You now have to consider sending out patches to your requirements, use cases, or models. This not only reduces user confusion but is also required by any tools that use this information. For example, a code generator that uses information in the design model to create the correct code depends on that model providing an accurate representation of the associated source code. It is a blessing because, especially when you provide the source code, it provides some of the benefits of open source software development. Your customers can provide their own patches and can send you their patches. This doesn't mean you have to accept their patches blindly, but it does give you a huge jump start in identifying and fixing problems.

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.


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.


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.


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.


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


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


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.


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.


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