Technical Manuals
Industry: Commercial Facilities
The Need
A manufacturer of commercial heating, ventilating, and air conditioning equipment had developed a building control system that managed facility comfort, lighting, and related electrical systems. The system included computer software and hardware, building control units, and control modules. The company wanted to create a set of documentation that could be used by installers, programmers, and end users.
Solution
Dashe & Thomson provided a lead and team of technical writers. The lead technical writer created a design and style guidelines and determined the content for each type of manual required. The team then developed a hardware and software installation manual, a system programming guide, and an operations guide, which included glossaries and indexes.
Results
The manuals designed for three different roles allowed the users to easily find the information they needed. The design of the manuals became the basis for future documentation.