Home > Articles

Documentation: Your Essential Discovery Tool

📄 Contents

  1. Navigating a Bad Network Neighborhood
  2. Documentation Dividends
  3. Summary
  4. Q&A
  5. Workshop
This chapter is from the book

I am always at a loss to know how much to believe of my own stories.

—Washington Irving, Tales of a Traveller

Would you start out on a car trip in a strange country without a map? Would you simply presume that you'll figure it out when you get there? Of course you wouldn't, but this is what people do every day when they fail to document their ever expanding networks.

When it comes time to troubleshoot, those who don't have a map to go by just shrug and shake their heads. Undocumented networks are mostly in-comprehensible. You need some method of getting your bearings, and network documentation can be an invaluable compass in what can be a sea of confusion.

This goes for an existing network as well as for one that you are just building. "As you build it, so shall it be," to quote one of my mentors. That is, if you build a network without documenting it for your future self, expect your future self to be befuddled, asking, "What exactly did my past self do here?" Networks are complex beasts by nature. And there is no such thing as a network that doesn't grow.

As such, it's absolutely essential that you and others who work on your network have some sort of well accepted rules (standard operating procedure, or SOP, to use the industry term) that dictate how and when you document. Just as no traditional job is finished until the paperwork is done, no network upgrade or addition is complete until the documentation is done. Documentation can include anything from logs and lists to charts and diagrams. It's anything that will make your life easier in the future.

You and your peers are not the only people who document your network, of course. Although you're the only folks who can document the way that your network is put together, it's worth your time and effort to completely read product documentation before deploying. It's amazing how many misconfigured (and thus malfunctioning) networks you will see with the simple problem that the implementers did not read the product documentation. Some problems are resolved, as they say out on the Net, by "RTFM" (Read The Fabulous Manual). (See Hour 6, "The Sesame Street Method: Using What Works," for more on vendor-supplied information.)

Navigating a Bad Network Neighborhood

Some people will tell you that complete documentation is too much trouble, or that it takes too much time and doesn't buy you all that much. This is utter hogwash. (Although many gray areas exist in network troubleshooting, this is one issue that is definitely black and white.) Folks without documented networks are the ones running around with their hair on fire; those with documented networks have fixed the problem, gone to lunch, done something productive, and gone home to spend time with their kids. This might sound rather judgmental, but too much evidence suggests that either you document once and have a reference during times of trouble or you fail to document at all and end up having to figure out something multiple times: once during each crisis.

For example, let's say that your wiring closet isn't labeled at all. Without documentation, if you are having a problem with a certain PC and want to check the switch port, you'd need to spend anywhere from 5 to 15 minutes tracing the cable from the workstation to the closet switch. Now multiply this by the many potential workstation cable problems that you'll see in your lifetime as a troubleshooter, and the amount of wasted time becomes horrific.

Not only does insufficient documentation waste time when your network is having problems, but it also causes unnecessary fear and confusion during the crisis . You owe it to yourself to have as clear a situation as possible when you start to troubleshoot—believe me, there's enough uncertainty and doubt when you're trying to find your way out of a bad network neighborhood without adding to it due to a lack of a good map.

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