Skip to content
  • it basics
  • troubleshooting
  • documentation and ticketing

Documentation & Ticketing

Why Documentation Matters

Section titled “Why Documentation Matters”

Documentation serves two critical purposes in IT:

  1. Keeps users informed - they know their issue is tracked and being worked on
  2. Creates an audit trail - lets you (or your teammates) review exactly what was done, in what order, and what the outcome was

Without documentation, you’re relying on memory - which fails at the worst moments.

Tickets vs. Bugs

Section titled “Tickets vs. Bugs”
TermDefinitionWho Creates It
TicketA tracked record of a user-reported issueUser or IT staff via helpdesk
BugAn issue with the system caused internally (not by the user)Developer or IT staff

Both get tracked in the same ticketing systems (e.g., Jira, ServiceNow, Zendesk, Freshdesk).

Anatomy of a Good Ticket

Section titled “Anatomy of a Good Ticket”

A well-written ticket includes:

Title:       Clear, specific summary of the issue
Reported by: User name + contact
Date/Time:   When the issue was first observed
Symptoms:    What the user is experiencing (in their words)
Environment: OS version, app version, device type
Steps to reproduce: What the user was doing when it happened
Priority:    Critical / High / Medium / Low
Status:      Open / In Progress / Awaiting User / Resolved
Resolution:  What was done to fix it (filled in when closed)

Writing Effective IT Documentation

Section titled “Writing Effective IT Documentation”

Good IT documentation is:

  • Specific: Avoid vague language like “fixed the issue.” Write “Rolled back the display driver to version 27.21.14.6109 to resolve screen flickering.”
  • Reproducible: Step-by-step instructions someone else can follow
  • Dated: Include timestamps - systems change over time
  • Living: Update documentation when procedures change - stale docs are dangerous

Documentation Example

Section titled “Documentation Example”

Problem: User unable to print to shared network printer after Windows update.

Steps taken:

  1. Confirmed printer was online and reachable via ping 192.168.1.45
  2. Checked print queue - found stalled job blocking the queue
  3. Cleared print queue via services.msc → Print Spooler → Restart
  4. Reinstalled printer driver from vendor site (HP v40.16.1.1)
  5. Confirmed user could print a test page successfully

Resolution: Windows update had replaced the vendor driver with a generic driver causing compatibility issues. Reinstalling the vendor-specific driver resolved the issue.

Building a Knowledge Base

Section titled “Building a Knowledge Base”

Recurring issues should be documented in a shared knowledge base - not just in tickets. A knowledge base article:

  • Documents a known issue and its solution
  • Saves time across the entire team
  • Enables users to self-serve (reduces ticket volume)

Structure:

Title: [Issue summary]
Symptoms: [What the user experiences]
Root Cause: [What's actually wrong]
Resolution: [Step-by-step fix]
Applies to: [OS version, software version, hardware model]
Last updated: [Date]

Documentation Hygiene

Section titled “Documentation Hygiene”

Stale documentation is worse than no documentation - someone will follow outdated steps with confidence and break something.

Best practices:

  • Review and update docs whenever a system changes
  • Mark outdated articles as deprecated rather than deleting (useful for historical reference)
  • Add version information - “Applies to Windows 10 21H2 and later”
  • Link related tickets to the knowledge base article that resolved them

Ticket Lifecycle

Section titled “Ticket Lifecycle”
User Reports Issue
      ↓
Ticket Created (Open)
      ↓
IT Assigned → Investigation begins (In Progress)
      ↓
Waiting for user input or parts? → Awaiting User / Vendor
      ↓
Fix Applied → Verified with user
      ↓
Ticket Closed → Resolution documented
      ↓
(If recurring) → Knowledge base article created