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: how to document multiple user roles? From:"Sean O'Donoghue-Hayes (EPA)" <Sean.O'Donoghue-Hayes -at- ericsson -dot- com -dot- au> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 4 Oct 2001 10:30:33 +1000
Sounds like a grand challenge. Here are my suggestions, pick and match as
you feel fit:
Perhaps have a note at the start of each task/process/procedure on whom can
perform this action.
And move all the tasks for (C) into an advanced, or specialised section (I
like this as it means that A+B don't need to read this, but can still look
and see all the things they could do if they coughed up more moolah).
Also could you structure the information by stating as the first step the
type of login/userid required to perform the action.
As a user I am sure I would try to beat the system, does the system actually
prohibit A users from accessing B and C functionality - I know on some
systems this "other" functionality is often unavailable ("grey-ed out").
Stating that certain functionality isn't available is always better if it is
shown on the system as being unavailable.
regards and thanks,
Sean O'Donoghue-Hayes
**Please note my email address changed on the 28th of September, 2001 to:
Sean.O'Donoghue-Hayes -at- ericsson -dot- com -dot- au
(61) (03) 9301-1695
EAA/N,
Melbourne Central, Level 49,
360 Elizabeth Street,
Melbourne 3000
-----Original Message-----
From: Writer Whirler [mailto:a_whirler -at- hotmail -dot- com]
Sent: Thursday, 4 October 2001 6:21 AM
To: TECHWR-L
Subject: how to document multiple user roles?
I am writing a user guide for an application whose users can have one of
three levels of permissions: A, A+B, or A+B+C. The business wants me to
write one user guide that incorporates all functions, instead of three
separate guides, which is fine with me.
My question is this: How much should I explain the three roles a user can
have?
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.
