Home > Articles

Like this article? We recommend

Documentation

Documentation in general is not considered part of the coding process, but perhaps it should be. Many programmers don't like it, but it is, of course, very important. This article would be incomplete without a discussion of this topic.

The two broad categories of documentation are internal and external. They serve different purposes and should be approached totally differently.

Internal documentation is mainly for the benefit of the programmer reading or modifying the source code. (I say "mainly" because I'll make an exception to this shortly.) There is not much to say about this except the advice that is routinely given to undergraduates: Comment profusely, especially the hardest parts of the code; comment at a high level and avoid useless comments such as "increment the counter"; and strive to keep the comments in sync with the code as it changes.

The concept of literate programming tends to blur this distinction because it advocates the generation of (at least some) external documentation from the internal docs. For example, you can put specially formatted comments and directives in your source and run a tool that will extract them and convert the result to HTML or a similar format. The open source tool cppdoc is one such tool (inspired by the Java equivalent javadoc). Such a tool is especially useful in generating an API reference because many tools can parse not just the comments but also the source to produce an excellent written "map" of your code.

External documentation is very important if you are creating something to be used by others. There are several kinds of this documentation, and they are not usually mutually exclusive. Most of the time, we will (or should) create all of them.

The installation notes usually take the form of a README file or the equivalent, which we routinely anticipate seeing in an archive. These notes will detail any instructions for building or installing the software. (As an aside, the process of building and installing should be automated as much as possible.) These notes should document any external dependencies such as third-party libraries or special operating system or software version requirements. They should also (when possible) document any quirks pertaining to specific compilers or operating systems. (It's not a bad idea to put comments in the makefiles also.)

The install notes should also document known bugs and limitations in the software. A version history is sometimes a good idea. Ideally, there should be a FAQ or a list of common problems and what to do if they are encountered. When possible, courtesy dictates pointing the user to external sources of help: users' groups, web pages, newsgroups, online tech support, and so on. This will vary depending on whether it is a commercial product or a free one, whether it is widely used software, and whether it is an individual or team effort.

It's an excellent idea to have tutorial information for your software. This might be plain text, but it's good to have a "prettier" format such as HTML. Show the user step by step what is going on, show one operation at a time, explain alternatives, and let the examples build on each other. When you refer to a whole file in the tutorial, point the user to a ready-to-run file in the distribution. If possible, let the test cases serve as additional examples (and comment them appropriately if you do).

Perhaps most important of all is to have reference documentation for the software. This should be in some hypertext format such as HTML, and may additionally be in some other form such as a command-line program that searches for a specified item and dumps a piece of information on that item. On Unix or Linux, man pages are a good idea; on Windows, the Windows help format is a standard.

As I said before, it's possible to generate much of this documentation automatically. This serves a dual purpose—it keeps the external documentation in sync with the source, and it motivates the programmer to keep the internal docs in line with the code itself.

If you do generate parts automatically, consider weaving in other parts by hand. If an occasional picture or diagram helps, don't hesitate to throw in a PNG file here and there. You might consider generating a PDF file for those users who want to print really nice-looking, page-oriented docs.

Documentation always gets out of date. When possible, point the user to an external resource that will be more current, such as a web page.

In short, remember the "golden rule" of documentation: Write the kind of docs that you like to see; the kind you wish you had for every piece of software. Think of it as software karma: What goes around comes around.

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