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.
I'm developing an outline for a proposed reorganization of our
Administrator's Guide. Over the years, there have been many
writers who worked on it, each with their own vision of what it
should be, and it's now a mish-mash of procedures, reference,
gui guide, and who-knows-what-all. I'm re-writing it from a
Basically we sell a database product that runs under either
Oracle or SQL, so some of our procedures are really two: setting
up the user (in Oracle) and setting up the user (in SQL) for
My problem: we have 2 kinds of users: administrative users, and
"other" users. You create them differently in the database, so
they are separate procedures. Since they're created differently
in SQL and Oracle, it's 4 procedures.
Should I group them by platform or by task? i.e.
-Setting up Users in Oracle
Creating the Adminestrative User
Creating Other Users
-Setting up the Administrative User
I'm leaning toward platform, but since my mandate is to rewrite
the thing so that it's task-based, I'm not sure.
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
Sponsored by Information Mapping, Inc., a professional services firm
specializing in Knowledge Management and e-content solutions. See http://www.infomap.com or 800-463-6627 for more about our solutions.
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.