0% found this document useful (0 votes)
256 views

TVL CSS11 Q4 M18

Network documentation provides a comprehensive record of a network's hardware, software, servers, user accounts, and how everything interacts. It is important for troubleshooting problems, maintaining consistency, transferring knowledge when staff leaves, and onboarding new employees. A 10-step checklist for network documentation includes creating a documentation policy, drawing topology diagrams, documenting server details, change logs, software and licenses, hardware components, backups, labeling equipment, and evaluating the documentation. Proper documentation can help quickly solve issues and is part of effective disaster recovery.

Uploaded by

Richard Sugbo
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
256 views

TVL CSS11 Q4 M18

Network documentation provides a comprehensive record of a network's hardware, software, servers, user accounts, and how everything interacts. It is important for troubleshooting problems, maintaining consistency, transferring knowledge when staff leaves, and onboarding new employees. A 10-step checklist for network documentation includes creating a documentation policy, drawing topology diagrams, documenting server details, change logs, software and licenses, hardware components, backups, labeling equipment, and evaluating the documentation. Proper documentation can help quickly solve issues and is part of effective disaster recovery.

Uploaded by

Richard Sugbo
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 8

Computer Systems

Servicing 11
Quarter 4
Self-Learning Module 18
Documentation checklist in Computer Networks
Development Team of the Self-Learning Module
Writer: Ronald S. Bobis
Editor:
Reviewers: Felix C. Vergara Jr.
Illustrator: Name
Layout Artist: Name
Management Team: Ma. Evalou Concepcion A. Agustin
OIC-Schools Division Superintendent
Aurelio G. Alfonso EdD
OIC-Assistant Schools Division Superintendent
Victor M. Javeña EdD
Chief, School Governance and Operations Division and
OIC-Chief, Curriculum Implementation Division

Education Program Supervisors

Librada L. Agon EdD (EPP/TLE/TVL/TVE)


Liza A. Alvarez (Science/STEM/SSP)
Bernard R. Balitao (AP/HUMSS)
Joselito E. Calios (English/SPFL/GAS)
Norlyn D. Conde EdD (MAPEH/SPA/SPS/HOPE/A&D/Sports)
Wilma Q. Del Rosario (LRMS/ADM)
Ma. Teresita E. Herrera EdD (Filipino/GAS/Piling Larang)
Perlita M. Ignacio PhD (EsP)
Dulce O. Santos PhD (Kindergarten/MTB-MLE)
Teresita P. Tagulao EdD (Mathematics/ABM)
EXPECTATIONS

After completing this lesson, you should be able to:


1. determine the checklist in computer networks.
2. explain how to create network documentation;
3. appreciate the importance of documentation checklist in computer networks.

PRETEST

Direction: Write T on the line if the statement is correct and F if the statement is
wrong.

___1. Proper documentation will save you from having to do time-consuming analysis
to solve recurrent problems.

___2. A network documentation policy should specify which aspects of a network,


especially each server, must be recorded. A documentation policy also informs each
administrator of what is required of them in terms of the documentation process.

___3. Keep in mind that a server can be allocated multiple IP addresses or have
multiple network interface cards, so that information should be recorded as well.

___4. Backup is the not the customer's best protection against a disaster, but it will
be useless if no one knows how to use it.

___5. Mark all servers, essential hardware components (gateways, routers, etc.), and
the most significant cables with a label creator.

RECAP
In your previous lesson, you were taught that Safe Mode is a special Windows boot-
up that can be used to restart the machine when it has encountered a critical issue
that prevents regular Windows functions and operations. Do you still remember
them? What are the steps on starting your computer in safe mode through settings?
__________________________________________________________________________________
__________________________________________________________________________________
__________________________________________________________________________________
__________________________________________________________________________________
__________________________________________________________________________________
__________________________________________________________________________________
__________________________________________________________________________________

LESSON

Network documentation is a comprehensive record of the hardware, software,


servers, directory structure, user accounts, data, and how everything interacts with
one another. Any information that assists administrators and IT professionals in
keeping the network up and running smoothly should be included in network
documents. This knowledge can be presented in any format you choose (though you
will notice that we suggest diagrams and other visuals for easy reference and better
communication with non-technical employees). What is most important is that the
material is readily available and understandable to those who need to relate to it.

The following are the reasons why network documentation is important:

• Proper documentation will save you from having to do time-consuming


analysis to solve recurrent problems.
• Consistency across the network helps to minimize problems and
mistakes because all is in order and everybody follows the same
processes and procedures.
• When a competent employee leaves the organization, you will not lose
critical information.
• The paperwork allows you to onboard new employees much faster.
• When problems arise, you can troubleshoot your network more quickly.

As you work, proper documentation should be made. Do not wait until all is in place
to begin documenting what you have done. It is much easier to recall what you did
in the moment than it is to try to remember what you did later. Make documenting
a routine and an integral part of your operation. Do not put yourself in potentially
embarrassing circumstances due to a lack of network documentation.

To help you get started, here is a 10-step network documentation checklist

Step 1: Create a network documentation policy - A network documentation policy


should specify which aspects of a network, especially each server, must be recorded.
A documentation policy also informs each administrator of what is required of them
in terms of the documentation process.

Step 2: Draw a topology diagram of your network. - Ideally, this topology map
should include each network segment, the routers that link the segments, and the
servers, gateways, and other major pieces of networking hardware that are linked to
each segment. For larger networks, you can need to build a general segment map as
well as individual segment
maps.

Image 1.0

Step 3: Document server names, roles, and IP addresses - Although the


information in a network topology diagram is not always descriptive, there is some
information that you can provide for and server, even if it must be put in an appendix.
List the server's name, IP address, and the function it plays for each server (domain
name system, Dynamic Host Configuration Protocol, mail server, etc.). Keep in mind
that a server can be allocated multiple IP addresses or have multiple network
interface cards, so that information should be recorded as well.

Step 4: For each server, create a change log - When a server fails, the cause is
often traced back to a recent update. Consider creating a logbook for each server as
part of the network documentation to record changes such as patch and program
installations and changed security settings. The log will not only assist you in
troubleshooting potential issues, but it will also assist you in rebuilding the server
in the event of a catastrophic failure.

Step 5: Keep track of software versions and licenses - Document the programs
and versions that are running on each server. Include a copy of the software license
or a receipt with this documentation in case the customer is subjected to a software
audit.

Step 6: Document hardware components - The documentation should include the


following information:

• How does the system communicate with the network?


• How is the interface set up?
• Is there a backup of the configuration?
• What firmware version does the system have?
• Is the computer set up to use a password? Include a password hint or a
reference to the password being written in a notebook that is kept in the safe,
but not the actual password.
Step 7: Create an Active Directory documentation - you should consider
documenting:

• The titles of the forest's domains.


• The layout of an Active Directory location.
• The location of the different servers inside the Active Directory hierarchy.
• Each group policy's location and content.
• External trusts if any exist.

Step 8: Document your backup procedures - Backup is the customer's best


protection against a disaster, but it will be useless if no one knows how to use it.
Make a note of the backup program used and its version (very important). You can
also record the tape rotation system, as well as a general overview of what is included
in and backup job and where the backup tapes are kept.

Step 9: Label everything - I once had a client ask me to help them with a
consultancy project. They provided me with a detailed and well-written copy of their
network documents to review ahead of time. When I arrived on site, however, I
discovered that none of the hardware was numbered. There was no way to
distinguish between the servers because they all looked the same.

Mark all servers, essential hardware components (gateways, routers, etc.), and the
most significant cables with a label creator. This will make identifying the different
pieces of hardware mentioned in your network document much easier.

Step 10: Evaluate your documentation - The final step of this network
documentation checklist is to assess your documentation to ensure that it meets
your and your customer's needs. Consider your network documentation to be an
essential component of your disaster recovery plan. When you have finished the first
draft of your documentation, ask yourself if it's good enough to help someone with
no previous knowledge of the setup restore the network from scratch in the event of
a disaster. If the response is yes, you have done an excellent job with the
documentation.

Even though it seems that no one reads the network documents, network
diagrams are critical for understanding current infrastructure, engaging with
stakeholders, onboarding new workers, troubleshooting problems until they
escalate, and developing a vision for future innovation. It makes no difference
whether you understand or not how network devices interact. You will learn this
experience gradually, working day by day. The most important thing is to genuinely
put in this initiative.
ACTIVITIES

A. Direction: Word Search

B. Direction: Create an infographic showing documentation checklist in


computer networks.
WRAP-UP

Direction: To assess yourself about the things you have learned from the lesson, fill
in the details below.

Today I learned that ______________________________________________


__________________________________________________________________
__________________________________________________________________
__________________________________________________________________
__________________________________________________________________

VALUING
DIRECTION: Read and answer the following questions carefully in two to three
sentences each number.

1. How will you use the knowledge you acquired about documentation checklist
in computer networks?

___________________________________________________________________
___________________________________________________________________
___________________________________________________________________

2. Cite a situation in which you can apply the knowledge of understanding


documentation checklist in computer networks?

___________________________________________________________________
___________________________________________________________________
___________________________________________________________________
POSTTEST

Direction: Write T on the line if the statement is correct and F if the statement is
wrong.

___1. Backup is the not the customer's best protection against a disaster, but it will
be useless if no one knows how to use it.

___2. Mark all servers, essential hardware components (gateways, routers, etc.), and
the most significant cables with a label creator.

___3. Proper documentation will save you from having to do time-consuming analysis
to solve recurrent problems.

___4. A network documentation policy should specify which aspects of a network,


especially each server, must be recorded. A documentation policy also informs each
administrator of what is required of them in terms of the documentation process.

___5. Keep in mind that a server can be allocated multiple IP addresses or have
multiple network interface cards, so that information should be recorded as well.

KEY TO CORRECTION

5. T 5. T
4. T 4. F
3. T 3. T
2. T 2. T
1. F 1. T
Posttest Pretest

References
• Google.” Testing your computer network” Accessed April 25, 2021.
https://www.lucidchart.com/blog/importance-of-network-documentation
• Google.” Procedure in network security” Accessed April 26, 2021
https://searchitchannel.techtarget.com/feature/Channel-Checklist-10-
steps-for-network-documentation
• Google.” Network inspection devices” Accessed April 27, 2021
https://www.wikihow.com/Create-a-Network-Documentation

You might also like