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.
Sarah writes:
"I'm just about to create a template for
an installation guide.
"I was wondering does anyone have any tips
about how an installation guide could be
formatted that makes it easy to read and
use?"
The formatting should consist of text, tables, graphics, and any other
information presentation formats suitable for the information you are
transmitting via the guide. White space should be used as appropriate to
distinguish blocks of information from each other and tie certain
information types together when needed. Headers and footers should be used
to contain such information as page numbers, company name, product name,
and/or running main heading information.
;)
Sorry, but ask a basic question... *g*
Look at other installation guides you've seen before and make judgment calls
based on the information you need to supply to your readers. I've seen
everything from an index card, to a poster-size visual guide, to a bound
manual. No one format is best. It all depends on what info you need to
supply to your readers, and what format makes sense for that info.
*****************
BILL SWALLOW
Technical Writer
C O U R I O N C O R P O R A T I O N
1881 Worcester Road
Framingham, Mass. 01701
T E L * 508-879-8400 x316
F A X * 508-879-8500
www.courion.com
*****************
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
TECH*COMM 2001 Conference, July 15-18 in Washington, DC
The Help Technology Conference, August 21-24 in Boston, MA
Details and online registration at http://www.SolutionsEvents.com
---
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.
