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.
For years, we have had a "Configuration Guide", in which the administrator of the system performs all roles to get started - even though a few actions are done by a client entity on a separate system. If the parties were distant, the one in charge might simply tell the other what to do next, or they might both read from copies of the same document.
So, "server side does this", then "client side does that", then "server side does this other", then "client side does something else."
We now want to switch to two separate guides that together accomplish the configuration task, in which the same basic actions take place, at the two ends, but now the client does the first move, by way of applying for a resource.
So, the server side would have the bigger document, with more stuff to do, and the client side would have a small guide with just three-or-four steps in it.
Now, instead of just steps alternating in a single list, where some steps are at one location, and some at another (even if it's two ends of the same table in a lab), the steps for each entity (in their own Guide) would be phrased as "when you receive this" or "when the other person has completed this-or-that action of theirs", now you do this action and tell the other person that you have done so. Two ends of a provisioning transaction.
The information contained in this electronic mail transmission
may be privileged and confidential, and therefore, protected
from disclosure. If you have received this communication in
error, please notify us immediately by replying to this
message and deleting it from your computer without copying
or disclosing it.
Doc-To-Help 2014 v1 now available. SharePoint 2013 support, NetHelp enhancements, and more. Read all about it.