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: Dealing with required/optional information in the same doc
Subject:RE: Dealing with required/optional information in the same doc From:"Bonnie Granat" <bgranat -at- granatedit -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Fri, 3 Jun 2005 17:38:31 -0400
>
> Sloppy Example:
>
> Backing Up Data
> Step 1: BIOS Config
> Step 2: Installation
> Step 3: Configuration
> Setting Up Replication
>
>
> Do I give even the optional steps a step number and just
> note it (Step
> 1: Backing Up Data (Optional)). Do I just bite the bullet and
manage
> two 30+ page chapters where only about 4 pages are different?
> (I'd love
> to have conditional or variable text right now but I don't, we
use
> InDesign.)
Victoria,
I would do almost as you suggest, with two changes:
- Make them all steps
- Instead of "Optional" in parentheses, say "For <config name>
only".
Bonnie Granat | www.GranatEdit.com
bgranat -at- granatedit -dot- com
Cambridge, Massachusetts, US
New from Quadralay Corporation: WebWorks ePublisher Pro! Easily create
14 online formats, including 6 Help systems, in a project-based
workflow. Live, online demo! http://www.webworks.com/techwr-l
Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.