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.
Where I work, we use a template that requires a "Before you begin"
clause at the start of each procedure. For example:
"Topic: Deleting a collection using the GUI
Purpose: this topic explains how to delete a collection from the GUI
Before you begin: Make sure the GUI is open and running. [You'd be
surprised. Or maybe not.]
Procedure: To delete a collection, follow these steps: ... [ad
nauseam]
Result: The collection is deleted."
Although this formulaic approach often makes me feel like a character in
Dilbert, the requirement does have its uses.
"Man does not live by words alone, despite the fact that he sometimes
has to eat them."
-Adlai Stevenson
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
A new book on Single Sourcing has been released by William Andrew
Publishing: _Single Sourcing: Building Modular Documentation_
is now available at: http://www.williamandrew.com/titles/1491.html.
Help Authoring Seminar 2003, coming soon to a city near you! Attend this
educational and affordable one-day seminar covering existing and emerging
trends in Help authoring technology. See http://www.ehelp.com/techwr-l2.
---
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.
