TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
The only thing I would change is in the following, adding the word "to":
d. Point the FILDIR directory to where you want the database files to
be created.
Everything else is just fine. Trust the developer. Anyone using that doc
*will* understand.
I don't have the time to give you an explanation of each item, but as a
technical editor, I would accept all but 4d as is.
>
> I need help with the following passage. My source has a bit of the
> mentality "the passage is fine because anyone who's reading
> the manual
> will know everything already, because I wrote it and *I* know
> everything
> already and so will anyone reading my text." My source does
> not welcome
> questions and clarifications that I believe are necessary. I
> need your
> perspectives.
>
I think that you need to learn more about the product and more about the
audience. That's the only thing I see lacking here.
It sounds as if you're in a bit over your head, frankly, and I wonder why
you are involved in the documentation of that product without a more solid
grounding in the product itself, the concepts related to it, and the needs
of the audience.
If the developer won't help you, do your own research.
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-