Documentation Best Practices | CompTIA A+ 220-1002 | 4.1

In this video you will learn about documentation best practices associated with being a good technician in I.T.

Network Topology Diagrams

A network topology diagram is a map of the structure of a network that may be depicted physically or logically. A physical network topology diagram is the placement of the various components of a network (such as device location & cable installation), while a logical network topology diagram illustrates how data flows within a network.

Physical Network Topology Diagram
Logical Network Topology Diagram

Knowledge Base and Articles

A knowledge base is a published collection of documentation that typically includes answers to frequently asked questions, how-to-guides, and troubleshooting instructions. Its purpose is to make it easy for people to find solutions to their problems without having to ask for help. The easiest way to access a knowledge base & its articles is to visit the support site for a product or do a search for a topic.

Typical Knowledge Base

Incident Documentation

An IT incident report is documentation of an event that has disrupted the normal operation of some IT system (or had the potential to do so) and how that situation is handled. In this context, events include any occurance that has significance for system hardware or software, and an incident is an event that must be dealt with to ensure that a system can continue to function.

Regulatory & Compliance Policy

Regulatory compliance describes the goal that organizations aspire to achieve in their efforts to ensure that they are aware of and take steps to comply with relevant laws, policies, and regulations. Due to the increasing number of regulations and need for operational transparency, organizations are increasingly adopting the use of consolidated and harmonized sets of compliance controls. This approach is used to ensure that all necessary governance requirements can be met without the unnecessary duplication of effort and activity from resources.

Acceptable Use Policy

An acceptable use policy (AUP) is a set of rules applied by the owner, creator or administrator of a network, website, or service, that restrict the ways in which the network, website or system may be used and sets guidelines as to how it should be used. AUP documents are written for corporations, businesses, universities, schools, internet service providers, and website owners, often to reduce the potential for legal action that may be taken by a user, and often with little prospect of enforcement.

Typical Acceptable Use Policy

Password Policy

A password policy is a set of rules designed to enhance computer security by encouraging users to employ strong passwords and use them properly. A password policy is often part of an organization’s official regulations and may be taught as part of security awareness training. Either the password policy is merely advisory, or the computer systems force users to comply with it. Some governments have national authentication frameworks that define requirements for user authentication to government services, including requirements for passwords.

Inventory Management

IT inventory management helps IT departments manage money and resources that are spent on technology. IT departments typically receive equipment that has to be tagged & tracked. Asset tracking refers to the method of tracking physical assets, either by scanning barcode labels attached to the assets or by using tags that use GPS or RFID which can broadcast their location. The tags are usually customized, with each one including the name of the organization along with a barcode and serial number. They are most often made of a metalized polyester that should last as long as the computer asset is expected to be in use.