Separate Guides?

Subject: Separate Guides?
From: "McLauchlan, Kevin" <Kevin -dot- McLauchlan -at- safenet-inc -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 4 Jun 2014 15:00:13 -0400

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.

Learn more:


You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at

Looking for the archived Techwr-l email discussions? Search our public email archives @


Previous by Author: Assume web-server knowledge?
Next by Author: RE: Separate Guides?
Previous by Thread: Re: Word 2013: Para markers on ruler not visible
Next by Thread: Re: Separate Guides?

What this post helpful? Share it with friends and colleagues:

Sponsored Ads