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.
On Mon, Mar 31, 2008 at 3:12 PM, Joel Wilhelm <eleysium -at- gmail -dot- com> wrote:
> In schematics, is there a standard for signal paths being either:
> 1. Left to right;
> 2. Right to left?
You may have a standard for your official engineering drawings.
However, for the purposes of a book, or training, it is better to
apply common sense to your book.
I have one diagram in a current book that flows top to bottom. Since
these are communication paths, you actually could say it is bottom to
top, if you start your discussion with the destination equipment. This
occurs in the functional description chapter.
In another part of the book, we discuss components as they appear in
the rack, starting at the top of the rack. This occurs in the
component description chapter.
In a troubleshooting section you may use a different flow, say from
the view of an operator, and where they may interact with the system.
Since you mentioned schematics, I assumed you meant an electronic
system. If you are documenting software, then a different set of
requirements may apply.
One thing to keep in mind is that if you eliminate path crossovers, a
diagram is much easier to understand. If you place a component in an
alternate location (not strictly in the left to right flow), and make
the diagram easier to understand, then my opinion that it is ok.
As you develop a writing and drawing technique that actually works for
users, you will run into some resistance from the engineering
discipline, where there is a strong belief that things are discrete
and always work in the prescribed fashion.
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-