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.
Much clearer! Repost what you wrote to me on the list and I think you'll get
more of what you're looking for.
As for task-oriented vs function-oriented, I always lean towards TO but I
make sure I have a solid Index to provide the function orientation that some
of the developpers might like.
I would give as much information about the functions as I could, but try to
keep the audience in mind, so make sure the information is about the
function itself and not too much contextual information that you're reader
should already know. Maybe you could make a reference to another book to get
some background information before tackling this new function.
> I'm really looking for is how to organize a developer's
> guide, in comparison to a User's guide.
I don't think they have to be that much different, but the developper's
guide is probably much drier (if that's possible) than a user's guide
because you don't have to worry about a programmer's comfort level.
--
Be seeing you,
Dave
---------------------------------------------
John David Hickey
Montreal, Quebec, Canada eh?
No trees were harmed in the writing of this email.
My emails are made from elephant tusks and dolphin meat.
---------------------------------------------
Don't confuse my opinion with my employer's.
Each exists in blissful ignorance of the other.
