RE: The Works

Subject: RE: The Works
From: "Margaret Cekis" <Margaret -dot- Cekis -at- comcast -dot- net>
To: "'Becca'" <becca -at- di -dot- org>, "'tech2wr-l'" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 14 Aug 2012 23:07:13 -0400

Becca talked about : ... "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? 
The only think I might suggest is a small "Quick reference card" type doc
with a list of the commands or common search terms or SQL queries that the
users would be using to access the info in the database. It's simple and
"old tech" that is often appreciated by new users of a complex application.
They can keep their reference card handy, and only have to go to the doc or
the help for more complex things after they learn the basics on the card.
Margaret Cekis, Johns Creek GA

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.


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 for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at

Looking for the archived Techwr-l email discussions? Search our public email archives @

The Works: From: Becca

Previous by Author: RE: document design: I don't know what I don't know
Next by Author: Re: Writing guides
Previous by Thread: Re: The Works
Next by Thread: Re: The Works

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

Sponsored Ads