Paul MacMartin Inc.
 
Home > User and reference docs
 

User guides and single-sourced docs

 
PORTFOLIO
User and reference docs
Instructional materials
Online help
Marketing content
Technical writing examples

RESOURCES
Home
About Paul MacMartin
Contact

 

Projects: User guides (single-sourced to XML, PDF, HTML Help, HTML, Word, ...), system architectures, sysadmin guides. AuthorIT templates, FrameMaker templates.

Services: Migrating to single-source authoring, developing single-source object templates, designing, prototyping and testing, interviewing subject matter experts and users, authoring, desktop publishing.

Tools: AuthorIT, FrameMaker, Epic Editor XML, Dreamweaver, Robohelp, MS Office, Acrobat, Photoshop, Visio, MS Project.

Examples:

IBM Tivoli fix pack readme
IBM software problem determination and troubleshooting guide 121-topic user guide for Tivoli Intelligent ThinkDynamic Orchestrator. Includes extensive logs analysis, troubleshooting, and documents more than 1000 error message dialog boxes. Sole-authored PDF for two product tiers, using Epic Editor single sourcing authoring tool.

307-topic PDF for digital signage network software technical writing example. Also single-sourced to HTML Help and Word.
Omnivex Display 3 Director User Guide 307-topic user guide for digital signage network software. As lead writer, structured all topics, authored topics, and single-sourced to PDF, HTML Help, and Word. As lead information developer, migrated Omnivex to AuthorIT single-sourcing platform, and trained writers to develop content in AuthorIT.

technical writing example - user's guide - Scientific-Atlanta
Scientific-Atlanta Installation and Operator Guide 88-page manual for the launch of the PowerVu D9828 Multiple Decryption Receiver. As sole technical writer, authored the manual including all GUI illustrations for the on-screen display. Authored in Word, Corel.

technical writing example - Canadian Forces HR Best Practices Manual
Canadian Forces HR Best Practices Manual 121-page best practices manual for the Canadian Military’s Employment and Education Service Providers. Redeveloped all content, developed document template and designed cover.

technical writing example - Laser Diode Drivers User Guide
BEI Laser – QCW Laser Diode Drivers User Guide 19-page user guide for the company’s high-output laser diode driver. In addition to revising and updating the original content, also designed and produced the cover concept.

technical writing example - user's guide - Scientific-Atlanta
BlueTree BT-2010 User Guide 60-page doc for a GPRS wireless data modem. As sole technical writer, single-sourced six manuals for six product platforms, and migrated the company from Word-based manuals to FrameMaker, including templates and technical writing manuals. Authored in FrameMaker.

Next step: Contact me by email, or by phone at
(416) 421-4710.


 
 
Phone: (416) 421-4710