Overview
I am tasked with designing documentation for a 3D scanner (Matrox AltiZ). As a Senior Technical Communications Specialist I am responsible for the Hardware Reference and Product User Guide, as well as all reference material, graphic content, and engineering reviews.
Objective
Create clear, structured documentation for a 3D imaging scanner used in industrial automation environments.
The documentation needs to support regulators, engineers, integrators, and technicians installing and configuring the hardware in production environments.
The Problem
The product documentation must translate complex engineering specifications into usable installation and configuration instructions for technical users.
Challenges
• Highly technical components
• Integration with industrial automation systems
• Multiple user audiences (engineers, technicians, system integrators)
• Maintaining documentation consistency across hardware, software, and UI guides
Process
Research
• Conduct interviews with engineers and product specialists
• Review technical specifications and internal engineering documentation
• Identify key user tasks such as installation, calibration, and troubleshooting
Content Design
• Structure the documentation using topic-based authoring principles
• Organize information into modular sections for easier navigation
• Create images, block diagrams, and graphics to explain complex topics in a simple way.
Tools
• FrameMaker for structured documentation
• Corel Draw for diagrams and screenshots
• Source Safe for versioning
• Adobe Acrobat for Review/Commenting, and Agile PLM for document release
Collaboration
• Work cross-functionally with engineering, regulatory, and product teams
• Validate documentation accuracy through SME review cycles
Documentation Solutions
Deliverables
• Product Reference Guide
(Hardware and Installation guide)
• Regulatory guide
Support quick-reference tasks and deep technical info by providing:
• System configuration and workflows
• Electrical specifications and pinouts
• Troubleshooting procedures
• Simplified visual diagrams and annotated screenshots
Results & Impact
• Enabled engineers and integrators to deploy the scanner in industrial environments
• Reduced ambiguity in installation and configuration procedures
• Provided consistent documentation across hardware, UI, and API materials
• Received positive feedback from customers and the marketing department