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.
Subject:Re: "using" as a verb in a task heading From:"Kathleen MacDowell" <kathleen -at- writefortheuser -dot- com> To:"Janice Gelb" <Janice -dot- Gelb -at- sun -dot- com> Date:Thu, 3 Jul 2008 00:16:03 -0500
I agree completely, Janice. For some reason I was thinking in terms of
brief sections only.
Re your comment requesting an example, Milan, I can't give you one off
the top of my head. But I think Janice's point addresses the same
issue from another angle. So I opt for providing context as the most
complete solution :-)
On Wed, Jul 2, 2008 at 10:48 PM, Janice Gelb <Janice -dot- Gelb -at- sun -dot- com> wrote:
> Milan Davidovic wrote:
>> On Wed, Jul 2, 2008 at 7:30 PM, Janice Gelb <Janice -dot- Gelb -at- sun -dot- com> wrote:
>>> Verbing the Noun
>>> To Verb the Noun at the Command Line
>>> To Verb the Noun Through the GUI
>>>
>>> If your documentation is entirely in print or in a help
>>> outline structure, you might be able to get away with
>>> not having to repeat the "verbing the noun" phrase as it
>>> will be right there.
>>
>> And as it turns out, it's print only.
>>
>> Stripping out the verb and leaving it as Method A/B (per Leonard) is
>> looking kind of good to me. Any other ideas?
>>
>
> Unless you are sure that the two method explanations will
> be within a page or so of the title of the containing
> section that contains the full verb, I recommend against
> merely putting the two methods in the section titles with
> no other context. Readers are likely to become confused
> and disoriented, or at the very least might have to flip
> pages to figure out what exactly they're supposed to be
> accomplishing with each method. Also, if these methods
> are also used elsewhere for other verbing activities,
> then readers could get *really* disoriented if they keep
> encountering "Method A" and "Method B" titles without
> any indication of context.
>
> -- Janice
>
> ***********************************************************
> Janice Gelb | The only connection Sun has with
> janice -dot- gelb -at- sun -dot- com | this message is the return address
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> Create HTML or Microsoft Word content and convert to Help file formats or
> printed documentation. Features include support for Windows Vista & 2007
> Microsoft Office, team authoring, plus more.
>http://www.DocToHelp.com/TechwrlList
>
> True single source, conditional content, PDF export, modular help.
> Help & Manual is the most powerful authoring tool for technical
> documentation. Boost your productivity! http://www.helpandmanual.com
>
> ---
> You are currently subscribed to TECHWR-L as kathleen -at- writefortheuser -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit http://lists.techwr-l.com/mailman/options/techwr-l/kathleen%40writefortheuser.com
>
>
> To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwr-l.com/ for more resources and info.
>
>
>
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-