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.
1) Separate out the basic, user-oriented information into a
supplemental section, either at the front or the end of the guide;
2) Separate each chapter by user and admin topics; and,
3) Place in the margin of each section text boxes that highlight
information of particular interest to either the user or the
administrator. Since you said the administrator is the primary
audience, summary information for the user might go well there.
I like the idea of having information arranged by topic as opposed to
by audience, so the third approach would be the one I would try to
work with. With a well-written work, one can move along from topic to
topic, selecting the depth to which one wants to delve into that
particular topic by starting with the main points (which should be
clearly stated early in the section) and taking in details as they're
needed.
Hope this helps.
Kevin Christy
Port/Christy & Associates
Los Angeles, CA
---Renee Lenti <Renee -dot- Lenti -at- COASTEK -dot- COM> wrote:
>
> I am creating a guide for a software application that accesses a
> database. The primary user of this guide is a system administrator who
> will be installing and using the software; however, there is some
> information that needs to be provided to the user responsible for
> running the external database that our software communicates with. If
> any of you have suggestions or experiences incorporating mulitple
users
> into a single guide, I would like to hear your them.
> Thanks,
> Renee
>
>
> Send commands to listserv -at- listserv -dot- okstate -dot- edu (e.g., SIGNOFF
TECHWR-L)
> Find TECHWR-L-related books at http://www.raycomm.com/techwhirl/books.htm
>
>
>
_________________________________________________________
DO YOU YAHOO!?
Get your free @yahoo.com address at http://mail.yahoo.com