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.
I've used "Site Preparation" and "Pre-Installation" before....but then
again, I was documenting huge hardware systems. I think the same heading
can be used for your situation.
Al Geist-Geist Arts, LLC
Fine Art Photography
Mobile: 231-301-5770
E-mail: al -at- geistarts -dot- com
Website: www.geistarts.com
Blog: www.gooterschmeltz.com
Facebook: Geist Arts
See Also:
Technical Communication, Help, Documentation Management
"We can't solve problems by using the same kind of thinking we used to
create them." (Albert Einstein)
-----Original Message-----
From: techwr-l-bounces+al=geistarts -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+al=geistarts -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of
McLauchlan, Kevin
Sent: Monday, October 28, 2013 12:53 PM
To: Martinek, Carla; techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: Pre-Installation heading
"___Prepare to Install" ??
-----Original Message-----
From: Martinek, Carla
Sent: October-28-13 11:44 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Pre-Installation heading
Looking for some feedback on the text for a heading in many of our
installation procedures for our products. They are written in the
imperative format (except for the first one, Parts List).
___Parts List
___Remove Part A
___Remove Part B
___Remove Part C
___Reinstall Part C
___Reinstall Part B
___Reinstall Part A
My issue is that there are times where we need to have a heading prior to
Remove Part A ... often it includes a decision table along the lines of
"which option do you need to remove/replace?" and they jump to Remove Part B
or Remove Part C and skip the ones before it. Or, it could be something such
as removing power from the system and removing supplies inside the machine.
Looking for some suggestions on what to call this heading. We've had a
heading that we're not happy with, but we can't seem to come up with
something we do like, so I thought I'd get ideas from the list and see if
someone else has a better idea.
___Parts List
___WHAT DO I CALL THIS?
___Remove Part A
___Remove Part B
___Remove Part C
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.
