eDialog - Barry Rogoff Technical Writing Samples

Go to content

Main menu:

e-Dialog was an e-mail marketing company that depended on a suite of proprietary and highly complex, Web-based application programs called Precision Central. The programs provided the means to create and execute large-scale, automated e-mail marketing campaigns tailored to specific audiences, and to capture and scientifically analyze the data produced by the campaigns. The programs were used internally except for a few "self-service" clients that depended on technical support. E-Dialog was absorbed by another division of the parent company many years ago.

I designed the first complete, current, and professional-quality documentation set for the Precision Central suite of applications and wrote most of it. This required learning the entire business from end-to-end because each part of Precision Central was used by different groups.

There are obvious typographic and other errors in these examples, particularly Trigger Manager. These errors were the result of being required to import the actual materials used by the sales and marketing groups exactly as provided. The corrections I gave those groups were never used and elevating the issue accomplished nothing.

The Precision Central documentation was published in HTML and PDF. The HTML files included a master table of contents, a master index, full-text search across the entire documentation set, and cross-reference links between all manuals. The PDF files had complete table of contents in the form of bookmarks, which are not displayed by the PDF rendering mechanisms in some current browsers.

I designed and implemented an automated documentation library build system that allowed all employees to review the work in progress every 24 hours in order to provide immediate feedback. The documentation library included all previous, current, and in-progress documentation sets.

For "security" reasons all components of Precision Central were required by software management to work within the Cold Fusion application server environment, without exception. Unfortunately, Cold Fusion did not support the Java technology used in the Author-it Web Help template, which was considerably more elegant and professional-looking than the HTML templates you'll see in these samples.
Back to content | Back to main menu