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, 20 May 1996 Claire Kapiri <claire -at- CTL -dot- COM -dot- CY> wrote:
>Are there any 'Rules of Thumbs' as to when to use a diagram/flow chart etc
>to illustrate a particular point in a document.
There sure are, it is a little complicated, but I will try to make
it simple:
First some definitions (very abbriviated version):
A "function" is e.g. "save a file under a new name".
A "step" is e.g. "2. Click the 'Save As' submenu".
A "visible" function is a function which is displayed directly or
which must obviously exist.
A "visible" step is a step which is displayed (e.g. as a choice) at
least at the end of the previous step.
If a function or a step is not "visible", it is "invisible".
If a product (or group of functions within a product) is complex and
contains a high number of invisible functions or invisible first
steps, there is a need for a flowchart or "function tree".
These terms and how to evaluate "product complexity" is further
discussed with detaisl and exceptions) in my book: "The PQM system.
How to write better instruction manuals and control their quality
yourself", which is avaliable from me (send me an e-mail for
delivery details). You can see more details about the book at http://www.pip.dknet.dk/~pip323/pqm-book.htm
The price of the book is DKK 200 + mailing etc. costs (non-registered
letter), total DKK 310 (~US$ 53). No VAT applies outside the EU.
Registered mail is DKK 27 (~US$ 5) extra.
Greetings from Denmark
Peter Ring
PRC - specialist in user friendly manuals and quality measurements on
manuals.
prc -at- pip -dot- dknet -dot- dk http://www.pip.dknet.dk/~pip323/index.htm
- homepage on user friendly instruction manuals with tips for
writers.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Post Message: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
Get Commands: LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU with "help" in body.
Unsubscribe: LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU with "signoff TECHWR-L"
Listowner: ejray -at- ionet -dot- net
