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.
Installation planning for X
Preparing to install X
X pre-installation checklist
On Mon, Oct 28, 2013 at 8:43 AM, Martinek, Carla <CMartinek -at- zebra -dot- com> wrote:
> 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
>
>
> Thx
> Carla
>
>
> - CONFIDENTIAL-
>
> This email and any files transmitted with it are confidential, and may also be legally privileged. If you are not the intended recipient, you may not review, use, copy, or distribute this message. If you receive this email in error, please notify the sender immediately by reply email and then delete this email.
>
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.
>
> Learn more: http://bit.ly/ZeOZeQ
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as robert -at- lauriston -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwhirl.com/email-discussion-groups/ for more resources and info.
>
> Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com
>
> Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.