Case study

AV documentation from zero

Creating the company's first AV documentation set for around 200 clients, plus a schematic tool that became the company-wide standard.

Date
Role
Author and tool builder
  • Documentation
  • Schematics
  • HTML
  • Canvas
  • Yealink
  • Neat
  • PPM

Problem

There was no AV documentation, either for client sites or for the service desk.

Without user guides, setup guides or schematics, every fault started from scratch, and knowledge of how a room was built lived with whoever installed it.

Constraints

  • Around 200 clients, each with its own mix of rooms and hardware.
  • Commercial schematic software would have meant ongoing licence costs.
  • The documents had to work for three audiences: end users in the room, service desk staff on the phone, and engineers on site.

Architecture

AV documentation setOne shared guide structure feeds four document types, which serve end users, the service desk and site engineers.StandardformatPrerequisites/ First Boot /Provision toplatform /Quick FixesUser guidesIssue reportsPPM checklistsSchematic toolsingle HTMLfileSchematicsEnd usersService deskSite engineers

The documentation set is a handful of document types built on one shared structure, so each one is quick to write and easy to scan.

What I built

A standard guide format. Every guide follows the same four sections:

  1. Prerequisites: what has to be true before you start (power, network, accounts, licences).
  2. First Boot: what you should see when the system powers on, and what “normal” looks like.
  3. Provision to platform: getting the device onto Teams, Zoom or the vendor’s management cloud.
  4. Quick Fixes: the common problems, each with a short fix.

Because every guide looks the same, the service desk knows where to look, and writing a new one is mostly filling in a known shape.

User and setup guides. Including Yealink A40 with CTP25 touch panel guides for both Teams and Zoom, and Neat Bar Pro and Pad setup guides.

Issue reports. A consistent template for recording faults, so a recurring problem shows up as a pattern rather than a series of one-off tickets.

PPM checklists. A standard checklist for quarterly preventive maintenance visits, covering displays, cameras, audio, codecs, control, network and cabling, so every visit covers the same ground whoever goes.

A schematic tool. Rather than pay for a commercial package, I built a schematic editor as a single HTML file: a canvas-based tool for drawing AV signal flow (devices, ports and connections) that runs in any browser with no install, no server and no licence.

Results

  • The company’s first AV documentation set, covering a client base of around 200.
  • The schematic tool is now used company-wide as the standard for schematics, with no commercial licence costs.
  • Quarterly PPM visits run from one standard checklist.

What I’d do next

  • Store the documentation as structured data (rooms, devices, firmware) so guides and schematics are generated from one source and can’t drift apart.
  • Link each document to the live device inventory, so a guide shows the room as it is now rather than as it was at install.
  • Make the guides searchable by an assistant, so the service desk can ask a question instead of opening a PDF.