Types of IT Documentation
Network documentation: logical diagrams (how devices are connected logically — IP addressing, VLANs, routing), physical diagrams (where devices are physically located — rack diagrams, floor plans, cable runs), network baseline (expected performance metrics for comparison during troubleshooting). Asset inventory: database of all hardware and software assets. Includes: device type, make/model, serial number, assigned user, location, purchase date, warranty expiry, OS version, installed software. Used for: support, procurement planning, auditing, compliance, disaster recovery. Standard Operating Procedures (SOPs): step-by-step documented procedures for common tasks. Ensures consistency even when performed by different technicians. Examples: new employee workstation setup, device disposal procedure, backup verification. Knowledge base / knowledgebase articles: documented solutions to previously resolved issues. Enables self-service for users and faster resolution by new technicians. Ticketing system documentation: every support interaction creates a ticket. Tickets include: user information, problem description, steps taken, resolution, time spent.
Ticketing Systems
Ticketing systems (help desk software) centralize and track support requests. Common platforms: ServiceNow, Jira Service Management, Zendesk, Freshdesk, ManageEngine ServiceDesk Plus. Ticket lifecycle: Open (user submits request) → Assigned (routed to technician) → In Progress (being worked) → Pending (waiting on user, vendor, or change approval) → Resolved (solution applied) → Closed (user confirmed resolution). Key ticket fields: User/requester, asset/device affected, priority (Critical, High, Medium, Low), category (hardware, software, network, account), description, resolution notes. Escalation: tickets that exceed resolution time SLA or require higher expertise escalate to Tier 2 or Tier 3 support. SLA (Service Level Agreement): commitment on response time and resolution time by priority. Priority matrix: Urgency × Impact = Priority. Critical: systems down, many users affected. Low: cosmetic issue, one user, workaround available.
Asset Inventory and Labeling
Asset tagging: each physical device gets a unique asset tag (barcode, QR code, or RFID). Asset tags printed and applied to device. Scanned into asset management database. Enables: quick identification, audit trail, theft detection. ITAM (IT Asset Management): processes and tools to manage assets throughout their lifecycle: procurement → deployment → maintenance → disposal. Software asset management (SAM): tracks software licenses to ensure compliance (avoid under-licensing fines, over-licensing waste). CMDB (Configuration Management Database): ITIL concept — tracks assets AND their relationships/dependencies (which server is connected to which switch, which app runs on which server). Network documentation must be kept current — outdated documentation is worse than no documentation (misdirects troubleshooting).
Regulatory and Compliance Documentation
Organizations in regulated industries must maintain specific documentation. Common regulations: HIPAA: healthcare — requires documented security policies, training records, breach notification procedures, and access control documentation. PCI-DSS: payment card industry — requires network diagrams, access control documentation, and quarterly vulnerability scan reports. GDPR: European data privacy — requires data processing records, consent documentation, breach notification. SOC 2: service organizations — auditors review security policies and documentation. Acceptable Use Policy (AUP): written policy users sign agreeing to appropriate use of IT resources. Privacy policy: how the organization handles personal data — required by GDPR and other regulations. Incident response plan: documented procedure for responding to security incidents. Business Continuity Plan (BCP) and Disaster Recovery Plan (DRP): documented procedures for maintaining operations during disruptions.