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: Which style of giving instructions is more effective?
Subject:Re: Which style of giving instructions is more effective? From:Alec Chakenov <alec -dot- chakenov -at- gmail -dot- com> To:Ryan Pollack <ryan -at- clicksecurity -dot- com> Date:Thu, 20 Dec 2012 01:26:00 +0600
I would choose "Restart the device ..."
2012/12/19 Ryan Pollack <ryan -at- clicksecurity -dot- com>
> Hi all,
>
> I'm debating the merits of two different styles of commands:
>
> "Enter the following command to restart the device:"
>
> (followed by the command itself)
>
> and
>
> "Restart the device by entering the following command:"
>
> (followed by the command itself)
>
> I've been flipping back & forth on these for years; now that I am creating
> a new documentation set, I'd like to be consistent, if that is even
> possible (or desirable).
>
> Any thoughts on the relative merits of each style? Situations when either
> would be useful? etc.
>
> Thanks for your input!
>
> --
>
> Ryan Pollack
> Senior Technical Writer | Click Security
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Writer Tip: Create 10 different outputs with Doc-To-Help -- including
> Mobile and EPUB.
>
> Read all about them: http://bit.ly/doc-to-help-10-outputs
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as alec -dot- chakenov -at- gmail -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
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Writer Tip: Create 10 different outputs with Doc-To-Help -- including Mobile and EPUB.