|
Caroline
L. Scharf |
|
Technical Writer |
|
||||
|
|
|
Software Documentation
Using industry-standard tools,
such as RoboHelp, FrameMaker, Webworks Publisher, and Microsoft Word, I
specialize in writing both print and online documentation for both end-user
and technical audiences.
|
|
|
|||
|
|
|
Samples
|
|
|
|
||
|
|
|
|
|
|
|
||
|
|
|
Web-based Online Help System: Using RoboHelp, I designed and wrote
modular help topics that could function as both a comprehensive web-based
help system and context-sensitive popup help. Users could browse the help
topics using the TOC and index, or quickly get answers using the popup help.
I implemented the popup help in the web-based application using Javascript. |
|
|
|
||
|
|
|
|
|
|
|||
|
|
|
|
|
|
|
||
|
|
|
Administrator Documentation Set: Using FrameMaker, I
wrote a documentation set for a new module in an existing enterprise-wide
application. The set includes an installation guide, database and system
administrator guide, data dictionary, and end-user online help system. I've
refined the documents over multiple releases during the last year and a half. |
|
|
|
||
|
|
|
|
|
|
|||
|
|
|
|
|
|
|
||
|
|
|
Printed & Online Getting Started Guide: Working
with the lead user-interface designer and a graphic designer, I wrote the
content for a printed guide to orient new users to the product and get them
quickly up and running. Working with the same team, I then modified the
content and messaging of the guide to create an online tour for new users who
log on to the system for the first time. |
|
|
|
||
|
|
|
|
|
|
|||
|
|
|
|
|
|
|
||
|
|
|
Technical White Paper: Working closely with the lead
architect, I wrote this white paper using FrameMaker and its drawing tools to
explain and illustrate the product architecture to a non-technical audience
of investors and potential customers. |
|
|
|
||
|
|
|
|
|
|
|
||
|
|
|
|
|
|
|
||
|
|
|
Training & Release Notes System: Using RoboHelp and
Snagit, I designed and wrote a set of web-based training sheets and release
notes. Our trainers printed out the training sheets for use during onsite
training sessions and customers had access to these materials online to
quickly refresh their memory or learn about new features. |
|
|
|
||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||
