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.
> -----Original Message-----
> From: John Posada [mailto:jposada99 -at- gmail -dot- com]
>
> > What's the best way to depict the interactions among six or
> > eight different things?
> >
>
> Our installation instructions for various devices requires that the
> user wait periods of time (for bootup, firmware download, handshake,
> etc.) as each device is added before the next device is added.
>
> We avoid tell the person how long various items must be down before
> connecting, or how long before the next item can be added...instead,
> we tell them to look for certain signs that something is ready, such
> as an LED switching from red, yellow, or blinking, to green.
>
> Can this be employed?
Thanks, but nah.
This would be for setting up how an assortment of devices and
programs were going to interact once they were all connected
and in operation.
Various components would have various timeout values in firmware or system software or a workstation driver, or a config file. Default settings might be fine in most cases, but if you make certain operational choices (like electing to use stronger encryption, which can have much longer key generation times), you might prefer to lengthen some timeouts. However, longer timeouts might collide with other considerations, like your connecting software having its own ideas about how long a transaction should last before deciding that something is wrong. You might have chosen an optional connection strategy that puts some devices in another room or another country, and thereby adds some client-server overhead and some network latency, which forces you to increase certain timeout values, but are other timeouts going to be affected in ways that you (or your third-party applications) don't like?
You might know that some of your systems and components live in a part of the world with choppy network reliability or speed, and the relaxed timeout settings (for some components) might be acceptable to you. Or, you might prefer to run a tighter ship and accept frequent timeouts and necessity for re-issue of certain commands and operations.
You might have chosen to combine certain operations and components in a way that we had not anticipated, for a purpose that we had not envisioned - you want to know what your boundaries are to enact your vision, but you don't want the info in the form of re-entrant word-spaghetti. You want a nice picture.
- k
<bumpf?>
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.
Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days. http://www.doctohelp.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
