The Works

Subject: The Works
From: Becca <becca_price -at- yahoo -dot- com>
To: tech2wr-l <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 14 Aug 2012 17:44:25 -0700 (PDT)

I'm on the edge of starting an independent contract, documenting the interface to a fairly involved database. There will be 2, maybe 3 groups of users, none of whom can know anything about the other groups. When the person who is creating the database and the interfaces pitched the idea of documentation to his end-cllients, they got all excited, and now say they want "the works" - help files, PDFs, and what ever else I can think of that would be useful. (I am under an NDA so I can't talk more about the end product.)

I figure separate help files for each user group, and printable reference manuals, but other than that, I'm not sure what "the works" entails. Any suggestions, please, for additional documentation that would be useful? 

I own Flare 8 for the help files, and have Acrobat X Pro to help with the pdfs.


This is my first independent contract after being out of work for several years (and after going back to school to upgrade my technical skills).  I want to make sure to do an excellent job on this, and cover all possible bases.'

Thanks for any advice you can give me!

-becca


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create and publish documentation through multiple channels with Doc-To-Help. Choose your authoring formats and get any output you may need.

Try Doc-To-Help, now with MS SharePoint integration, free for 30-days.

http://bit.ly/doc-to-help

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Follow-Ups:

Previous by Author: Re: LaTeX and output to MS-Word
Next by Author: Re: The Works
Previous by Thread: Re: FrameMaker 11 and 9 - Doc Team expansion, help.
Next by Thread: Re: The Works


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads