Paul MacMartin Inc.
 
Home > Technical Writing Examples
 

Technical writing examples

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

RESOURCES
Home
About Paul MacMartin
Contact

 

User guides and reference manuals technical writing 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.

IBM Tivoli network orchestration software installation guide
IBM software installation guide 204-topic doc for IBM's Tivoli Intelligent ThinkDynamic Orchestrator as one of a team of three authors. Included XML single sourcing six guides for two product tiers and three operating systems. Authored in Epic Editor to implment XML authoring to PDF.

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 PNC User Guide 446-page doc for PowerVu Network Centre software that controls TV broadcasters' globally networked devices. As sole technical writer, documented new features for a major release, and single-sourced two guides for two product tiers. Authored in FrameMaker.

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.

198-topic user guide for contract research organization's flagship clinical data management software. Also single-sourced to HTML Help and Word.
SciAn EDC Pro Study Configuration Guide 198-topic user guide for contract research organization's flagship clinical data management software (one of 14 docs). As sole technical writer, single-sourced in AuthorIT to PDF, HTML Help, and Word.

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 for the company, 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.

FrameMaker templates examples - FrameMaker Templates User Guide
FrameMaker Templates User Guide
42-page doc helps VisualSonics staff create and edit documents based on the original FrameMaker templates I designed and built for the company. Authored in FrameMaker.

technical writing templates
VisualSonics Rail System Operator Manual 67-page doc for a three-component lab research system that interfaces with the company's high resolution imaging system. As sole technical writer for the company, designed and authored the document in FrameMaker.

Online electronic data capture user guide
SciAn CDM Manager User Guide As sole technical writer for the company, authored 68-page doc for the launch of this contract research organization's flagship clinical data management software. Migrated the company from Word-based documentation to FrameMaker, including templates and technical writing manuals. Authored in FrameMaker.

Online electronic data capture user guide
SciAn Electronic Data Capture System User Guide As sole technical writer for the company, authored 37-page doc for the launch of this contract research organization's online electronic data capture system for clinical trial sites. Authored in FrameMaker.

Online help and single-sourced docs technical writing examples

442-topic XHTML online help system for the company’s hardware and software high-resolution ultrasound imaging system.
VisualSonics Vevo 2100 Help 442-topic XHTML online help system for the company’s hardware and software high-resolution ultrasound imaging system. As sole contract technical writer, designed and developed custom print output template and custom XHTML template for single-sourcing output. Developed 442 topics and the 101-term index. Published to XHTML Help and PDF.

51-topic XHTML online help system for the API definitions available to the reseller partners of this VoIP international calling service.
Mobivox API Definitions Help 51-topic XHTML online help system for the API definitions available to the reseller partners of this VoIP international calling service. As sole contract technical writer, designed and developed custom print output template and custom XHTML template for single-sourcing output. Developed all content and published to XHTML Help.

51-topic XHTML online help system for the API definitions available to the reseller partners of this VoIP international calling service.
Scian EDC Pro Help 198-topic XHTML online help system for this contract research organization's flagship clinical data management software (one of 14 docs). As sole contract technical writer, designed and developed custom print output template and custom XHTML template for single-sourcing output. Developed all content and published to XHTML Help and PDF.

307-topic HTML Help for digital signage network software technical writing example. Also single-sourced to PDF 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 HTML Help, PDF and Word. As lead information developer, migrated Omnivex to single-sourcing platform, and trained writers to develop single-sourced content.

81-topic context-sensitive online help system technical writing example
Firmex Data Room Help 132-topic XHTML online help system for the company’s private-label virtual data room. As sole contract technical writer, designed and developed custom print output template and custom XHTML template for single-sourcing output. Developed 132 topics and the 65-term index. Published to XHTML Help and PDF.

81-topic context-sensitive online help system technical writing example
Telus DM Help 50-topic XHTML online help system for the online print ordering system for this Canadian telecommunications company. As sole contract technical writer, designed and developed custom print output template and custom XHTML template for single-sourcing output. Developed all content and published to XHTML Help and PDF.

81-topic context-sensitive online help system technical writing example
Transcontinental Printing Job Buildout Help 131-topic XHTML online help system for the company’s print job buildout system. As sole contract technical writer, designed and developed custom print output template and custom XHTML template for single-sourcing output. Developed 131 topics and the 133-term index. Published to XHTML Help.

81-topic context-sensitive online help system technical writing example
StoresHub Document Center Help 35-topic XHTML online help system for the company’s private-label document storage repository. As sole contract technical writer, designed and developed custom print output template and custom XHTML template for single-sourcing output. Developed all content and published to XHTML Help.

IBM Tivoli network orchestration software installation guide
IBM software readme Sole-authored the 13-page readme, and the summary document of the 31 resolved defects for Tivoli Intelligent ThinkDynamic Orchestrator V 2.1. For xml single sourcing, authored in Epic Editor to implement XML authoring to HTML.

Instructional materials technical writing examples

Vevo 2100 Screen Video
Omnivex Moxie courses 8-module, 22-exercise, 72-page workbook for this hands-on 2-day course that teaches advanced features of Omnivex Moxie digital signage software. As sole technical writer, conceived and developed the course, developed 90% of the exercise files, then developed the student and trainer workbooks. One of 5 courses I have conceived and produced for the company.

Vevo 2100 Screen Video
Application Video Training Designed, wrote, narrated and produced application video content for Visualsonics' Vevo 2100 High Resolution Imaging System, in addition to completing the 456-page operator manual/online help system.

Technical Writing training course
Technical Writing training course 17-module, 38-exercise, 92-page workbook for my 2-day course that gives participants a practical introduction to the core technical writing skills. Developed all content and graphics. I have delivered this customized course content to individual corporations such as Rogers Communications, as well as to groups of individual participants from a range of corporations.

CIBC 64-screen Web-based sales training module - bank technical writing, financial writing samples
Selling Managed Portfolio Services 64-topic Web-based sales training module. One of seven authored for this major Canadian bank's 19-module Selling Priority Products staff training course.

10-page take-away document linked to class-based training - bank technical writing, financial writing samples
Document Management System Training Guide 10-page take-away document. Linked to facilitator-based training of global IT group leaders for Big-5 accounting firm's national document management system. Writing, design, desktop publishing.

286-page personal financial planning user guide - bank technical writing, financial writing samples
Financial Pursuit 286-page personal financial planning user guide. As lead editor for the company, ghost-wrote selected chapters, and edited for author Graydon Watters.

248-page Prentice Hall Canada emotional management skills book technical writing examples
One Powerful Mind 248-page Prentice Hall Canada emotional management skills book. Ghost-wrote and edited the book for author Paul Witz.

Marketing content technical writing examples

Leitch Technology 12-page corporate brochure technical writing examples
Leitch Technology - Neo brochure 12-page brochure. One of four brochures for the company introducing integrated modular television broadcast platforms, and a broadcast network control system. Writing only.

Advantex 24-page technical writing annual report
Advantex annual report 24-page document for a loyalty marketing company serving institutions with large customer databases. As lead writer, worked closely with the Chairman and CEO, and members of the senior executive team. Writing only.

Seven case studies from notes and text content provided by IPEX.
IPEX case study series Developed seven case studies from notes and text content provided by IPEX. Each case in the series follows the Background / Problem / Solution structure. Writing only.

Exact IT Solutions brochure technical writing example
Exact IT Solutions brochure Four-page brochure for this provider of Toronto-based IT outsourcing services. Developed all writing and laid out the design elements.

algorithmics.com: content for financial risk management software company website technical writing example
algorithmics.com Wrote and coded web content for this financial risk management software company's corporate website. Interviewed company VPs, Directors and product managers to develop content. Doh!-note: I should have screen captured the site as it was when I wrote the content. It has changed now and none of it's mine anymore. Imagine brilliant stuff, though, written by a clearly not-so-brilliant guy.

4-page document launching an ASP health tracking and information resource for employees technical writing example
Health & Wellness Companion 4-page brochure launching an employee based health tracking Internet application. As lead technical writer, worked with company President and senior executives. Writing only.

The Client 12-page quarterly corporate newsletter technical writing example
The Client quarterly newsletter 12-page quarterly corporate newsletter for company sales reps. As sole writer, interviewed company CEO, senior executives, and selected company reps to develop the editorial plan and write stories. Writing only.

What's UP 4-page quarterly consumer newsletter technical writing example
What's UP quarterly newsletter 4-page quarterly consumer newsletter. As sole writer for the company, interviewed CEO, senior executives, and product managers to develop the editorial plan and write the stories. Writing only.

Northern Telecom Review 16-page quarterly corporate newsletter technical writing example
Northern Telecom Review newsletter 1987. This thing is so old, I remember the graphic designer angrily cutting and pasting Compugraphic cold type sheets when I'd make a type-o. As sole writer, interviewed company design engineers and product managers to write all articles for this quarterly newsletter detailing Nortel telecom product innovations. Did I ever work with hot metal type? Yes. Papyrus, no.

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


 
 
Phone: (416) 421-4710