Home > Articles > Programming > General Programming/Other Languages

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

Writing about Software

You’re probably familiar with the classic outline: a hierarchical, indented list of items. It’s a fantastic way to keep track of projects, and there are plenty of apps out there for keeping such lists. While reading this chapter, though, think about all the different practices there are for writing about software design and development:

  • Traditional outlines are great for exploring ideas in your initial mental sweep, constructing requirements documents, and communicating complicated ideas to a team. At any point in a project, if you find yourself up against a complex problem, consider building a traditional outline to make sense of it. Folks with analytical minds often feel that outlines are the most natural way for them to organize information. You’ll find a number of excellent outlining applications for Mac and iPad that make it easy.
  • Plain text files are a nice, simple way of jotting down ideas and things to consider. But it’s harder to make text files hierarchical and clearly itemized. They’re easy to share, especially if you keep them in sync via a cloud service.
  • Tasks in a to-do application can keep you on track once you’ve figured out what needs to be done. They tend to be ephemeral and personal, though, rather than providing a team with a comprehensive and definitive record of everything about a topic.
  • Tickets in a bug-tracking database make it easier for everyone on a team to see the current understanding of a problem, the discussions that have happened around it, and the proposed solution. But they’re not great at giving a big-picture view; you can’t rely on bug tracking to help you understand anything bigger than an individual problem.
  • Paper and whiteboards are perfect for quick, in-person planning on your own or while meeting with someone else. And there is still no easier way to gracefully combine outlining and sketching. Once you’re finished with a whiteboard session, you can take a photo for safekeeping, in case you ever wonder, “What were we thinking in that meeting?”
  • Plans in project-management software are a formal way of keeping track of what needs to be done. For project managers and other boss types, they can be invaluable for keeping an eye on the big picture, but they’re not very useful for focusing on the decision-to-decision detail of a tough design problem.
  • A design specification, or “spec,” is a definitive, complete description of a team’s plans and intentions for a piece of software. Depending on how formal your organization and your processes are, you might even be required to follow the IEEE 1016 standard for this kind of document.

Most likely, you will find yourself using some combination of these tools to keep track of the various levels of detail in your design project: attaching text files to bug reports, transcribing photos of whiteboard lists into specification outlines, and so on. Which ones you prefer will depend on how much detail you need, whether you’re working with a team, and which apps you’re comfortable using.

What’s important is to put together comprehensive, itemized lists of things that need to be considered for your project, from the grandest goals to the tiniest, hair-splittingest details. Some outlines may be hundreds of items long, such as a write-up of all the components in the architecture of a complex app. Others may be just a handful of highly precise decisions that took hours of agonizing to get just right.

Even if you don’t prepare formal specs, it’s often invaluable to have a single document (or set of documents), as casual or as formal as you want, to fully describe the team’s understanding of what it is they’re building. (And it’s helpful even if you’re not working with a team!) Keep these specs checked in to your version control system just like source code, and keep them up-to-date.

Also keep the designs for—and the discussions about—rejected ideas, because they illustrate why you didn’t go with a certain seemingly appealing choice. Rejected ideas keep you from having the same arguments over and over again, and they become part of the “antirequirements” of the app, described later. Treating the software itself as its own spec is a great way to lose track of important work that needs doing, or for people to misunderstand incomplete bits of the software as being intentional and already finalized.

  • + 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