Re: front matter in manuals

[Edwin Skau <eddy -dot- skau -at- gmail -dot- com>]

> I don't put that sort of section in.
>
> I do put in a preface that contains typographical conventions and
> formats.
>
> I also make the first chapter an introduction, stating the manual's
> purpose, audience, and "prerequisities". That last category states what
> I think the reader's background should be.
>

Well, that is "that sort of section".

When you define an intended/target audience, that description is
loaded with assumptions. Some of us continue to be more granular
(...know how to use the mouse, switch off the lights and brush your
teeth) than others. Others assume that mentioning a role and
responsibility conveys those assumptions. You's expect an SDK user to
be conversant with the programming paradigm, etc.

To leave out purpose (, scope,) and intended audience definitions is
to open up your document to a whole range of unwarranted expectations
from all kinds of incidental readers.

-ed

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

Try WebWorks ePublisher Pro for Word today! Smooth migration of legacy
RoboHelp content into your new Help systems. EContent Magazine Decision-
maker review (October 2005) is here: http://www.webworks.com/techwr-l

Doc-To-Help 2005 converts RoboHelp files with one click. Author with Word or any HTML editor. Visit our site to see a conversion demo movie and learn more. http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.