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.
RE: How do you prefer to deal with long flowcharts?
Subject:RE: How do you prefer to deal with long flowcharts? From:SIANNON -at- VISUS -dot- JNJ -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 24 May 2002 14:40:44
Bruce Byfield notes:
> Often, too, you'll find that the more abstract version is all
> that users actually need. However, if they do need more detail,
> and the details occupy more than a single page, then the abstract
> version will still help users to grasp the entire system being charted.
I wanted to insert a comment here because this "what do you *really* need
to show here" analysis may be one of the parameters in which I will find
more variation in the future. The doc in question for my example isn't an
end-user doc, but rather part of the design docs.[1] I can see how other
examples of the same concept, however, may benefit from this approach in
the future. It reminds me of the screenshot discussion, frankly, and the
idea of an "establishing shot" vs. an "action sequence".[2]
Shauna
[1] (It's a system, not project doc--in my current doc set, the system
design docs are a live "as is" representation of the system's current
design, while project design docs are more limited,...just the specs the
developers generate for the specific piece of a system being created or
modified. Excerpts from system design docs may be used to help
explain/explore issues with non-code-speaking internal customers when we
develop requirements for system modifications, or to show an FDA auditor
how an app. applies 'enforced permitted sequencing of steps', etc.)
[2] (...OK, maybe this is just part of me that is subconsciously trying to
make sure I see Star Wars Episode 2 this weekend...)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Free copy of ARTS PDF Tools when you register for the PDF
Conference by May 15. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.com
Check out RoboDemo for tutorials! It makes creating full-motion software
demonstrations and other onscreen support materials easy and intuitive.
Need RoboHelp? Save $100 on RoboHelp Office in May with our mail-in rebate.
Go to http://www.ehelp.com/techwr-l
---
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.