Technical Writing


01 / SYMANTEC

Integrated Secure Gateway (ISG) Documentation

As lead technical writer for the Symantec Integrated Secure Gateway (ISG) for approximately five years, I redesigned the documentation architecture to make a complex enterprise security platform easier to understand and navigate.

The original documentation presented users with a relatively flat hierarchy and an overwhelming number of topics on the landing page. I replaced this approach with a structured system of almost 300 task-oriented topics, organized into familiar documentation categories: Admin Guide, Best Practices, Console Guide, and CLI Reference.

The result was a cleaner landing page with logical points of entry and a more intuitive path through the documentation.


02 / SYMANTEC

S620 Security Appliance Maintenance Topics

Organized appliance maintenance documentation around the physical workflow of servicing the hardware. Each procedure builds on the preceding steps, establishing the prerequisites for accessing, removing, and replacing internal components.

Powering down the appliance precedes removing its cover; removing the riser card precedes installing a network interface card. The sequence of information mirrors the sequence of operations. Click the following page to view the S620 Fan topic, which references earlier procedures within the procedure for replacing the fan.

Concise instructions and CAD-based illustrations work together to guide technicians through complex maintenance tasks with clarity and precision.


03 / SYMANTEC

Redesigned Security Appliance Quick Start Guides

I redesigned the appliance Quick Start Guides from oversized, commercially printed posters to standard letter-size documents that could be printed in-house on a color laser printer.

The smaller format required a fundamental reassessment of the content. I streamlined the layout, tightened procedural writing, consolidated technical illustrations, and moved supporting details to online documentation. In one representative comparison, the word count decreased from 2,138 to 1,527—a reduction of nearly 29%—while preserving the essential installation and configuration workflow. Click the following images to see the original and redesigned Quick Start Guides.

The redesigned guides eliminated the need for expensive outsourced printing and reduced production time, demonstrating how thoughtful information design can improve usability while reducing costs.


04 / MEYER SOUND

Comprehensive Loudspeaker Documentation

Developed a comprehensive documentation set for Meyer Sound professional loudspeaker systems, including Operating Instructions, Assembly Guides, Datasheets, and FAQs.

Operating Instructions cover electrical safety, AC power distribution, current and voltage requirements, cable assembly, three-phase Wye wiring configurations, audio connections, amplification, and RMS remote monitoring.

Assembly Guides document hardware configurations, load ratings, safety requirements, and procedures for assembling and suspending loudspeaker arrays, including integration with compatible loudspeakers and low-frequency elements.

Datasheets include product descriptions, features and benefits, applications, technical specifications, dimensional drawings, and architect specifications.

FAQs address common questions about system capabilities, configuration, compatibility, and operation.

Throughout, I integrated precise technical writing with CAD-based illustrations, wiring diagrams, and dimensional drawings to make complex systems easier to understand, configure, and operate safely.