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:how to document multiple user roles? From:"Writer Whirler" <a_whirler -at- hotmail -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 03 Oct 2001 15:20:47 -0500
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? For example, when describing the "C" function, should I explain that
you cannot perform the "C" function (the option does not even appear on your
system)if you do not have permission to do so? Or is it enough to just
explain all of the functions, and not offer any overall explanation of what
functions your permissions entitle you to.
I should explain that the application I am writing about is a very
specialized financial trading application with a limited user base. It's not
something you can get off the shelf and install yourself. Users must be
registered, and set up with a specific data set and accounts. In the past
we've assumed a certain level of knowledge on the part of the users (they
know what they can do and there's no need to explain their roles because by
the time they get access to the system that's all been explained).
But I've been rethinking that assumption lately and want to get more
opinions. Thanks in advance for any advice.
_________________________________________________________________
Get your FREE download of MSN Explorer at http://explorer.msn.com/intl.asp
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.
