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.
Subject:RE: Re. How to document multiple user roles? From:david -dot- locke -at- amd -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 4 Oct 2001 12:27:25 -0500
I'm a stickler for role-based books. In the case where tasks are mutually
exclusive and it has to be in one book. I would break the book into sections
where each section covered the concepts, conceptual model, features, and
tasks for a particular role.
I've documented network administration utilities where one level of
administrator could get reports and another had to enable that
administrator's ability to query. Tunneling was used, so some admins kept
secrets from other admins.
It seems like a mistake to tell non-admins about admin tasks. I know that
I've had to cover up admin roles, because TCO was an issue. My company
didn't want customers thinking that needed to administer the software. We
took what would have been a single book and included it as a section in the
user manual. Seems like fraud.
Omitting admin or burying it makes purchase decisions harder for the
customer. SAP has been sold on the basis of cost savings. Few of these
savings ever show up, because of the administrative burden. The issue of how
to organize the content impacts things outside the scope of the vendor
organization.
Planning to attend IPCC 01, October 24-27 in Santa Fe? Sign up by
October 3 and get a substantial discount! Program information,
online registration, and more on http://ieeepcs.org/2001/
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.