Home > Articles > Software Development & Management > Object Technology

Increase the Accessibility and Comprehensibility of a Visual Model with Literate Modeling

Literate Modeling, which was discovered and first described by author Jim Arlow, can increase the accessibility and comprehensibility of a visual model by embedding it in an explanatory narrative. Take this opportunity to learn from the source how to improve your UML modeling and add value to your models with LM.
Like this article? We recommend

Literate Modeling (LM) is a way of increasing the accessibility and comprehensibility of a visual model by embedding it in an explanatory narrative.

The technique was discovered in 1999 and first described in [Arlow 1]. I’m careful to say "discovered" rather than "created" because on publication of the paper I received many emails from modelers saying that they had been using LM for some time without knowing what to call it! As such, LM merely reflects the best practice of experienced modelers rather than any particularly new technique.

In this article, I’ll consider LM applied to UML models, but you should bear in mind that the technique is applicable to any visual modeling language.

Essentially, what you are doing in LM is tying your UML model, precisely and consistently, to a narrative description of the business domain called a Business Context. This deceptively simple strategy has very significant benefits that will become more and more apparent to you with each Literate Model you create:

  • Your UML models will be greatly improved because many more people can understand them and review them.
  • Writing the Business Context demands that you to understand the business domain deeply. Obviously, this will also improve your models.
  • The Business Context will highlight omissions and mistakes in the UML model. Something that might look OK in UML might turn out to be wrong when described in the Business Context.
  • As you will see in the next section, LM creates a controlled vocabulary that gives you a consistent and correct way of talking about the business in your project.
  • You can achieve very high levels of consistency in both your Business Context and UML model by virtue of them one correcting and refining the other.

The bottom line is that LM makes you a better modeler!

In the next couple of sections, we will look at some problems with visual languages and some reasons why LM is needed.

Encryption of Business Requirements and Semantics

There is a common belief that visual languages are in some way more easily understandable than text—hence the saying "a picture is worth a thousand words."

The superiority of pictures for certain types of communication was certainly one of the driving forces for the creation of UML. There was a broad consensus in the software industry that a visual representation of a software system would be more precise than a narrative description and yet more accessible and comprehensible than the source code. Perhaps more importantly, pictures allow the system to be visualized at many different levels of abstraction before committing time and resources to create the source code at the lowest level of abstraction.

Although the UML has been a great boon to analysts and designers, it’s important to realize that in some circumstances pictures don’t clarify at all—they obscure. Visual languages such as UML express key business requirements and semantics in a complex visual syntax that is comprehensible only to those who understand the language. With regard to UML, key business requirements and semantics become captured, encoded and, for those who don’t know UML, encrypted in models. This realization was our point of departure in our initial paper on LM [Arlow 1]; that from the perspective of the majority of the stakeholders on a typical UML project, key business requirements and semantics are encrypted in the UML models. In [Arlow 1] and [Arlow 2], we examined the various UML diagram types and assigned a tentative comprehensibility to them for the different types of stakeholders.

Encryption presents the analyst with a fundamental issue of traceability. Information tends to flow one way from the non–UML-aware stakeholders to the UML-aware modelers becoming encrypted in the process. The UML work products of the analysts are only partially and imperfectly comprehended by the majority of the stakeholders. This means that the non–UML-aware stakeholders can’t easily check and validate the UML models. This is a very big problem because it is generally the stakeholders that have the best understanding of the business domain.

Encryption is a problem whenever a UML model needs to be understood by someone who only partially understands UML. Many programmers have trouble understanding the full implications of a UML model because their knowledge of UML is incomplete. This can have a very negative impact on how they realize the model in code. Similarly, many modelers have difficulty producing precise UML models because although they understand UML syntax, they might not completely understand the underlying UML semantics or use it in an idiomatic way. This is amply demonstrated by many of the books on UML.

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