Subject:RE: To Gerund or Not to Gerund? From:"Lauren" <lt34 -at- csus -dot- edu> To:"'Tsipi Erann'" <tsipi -dot- erann -at- gmail -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 20 Aug 2007 11:29:10 -0700
If you were a reader of the document, what phrasing would annoy you more?
Avoid that one.
Although, I prefer concrete phrasing in my documentation, I like my headings
to be approachable and to invite readers to read. If "Add Files to the
Database" became the chosen phrase, then I would want to preface it with
"How to," but "Adding Files..." also sounds approachable to me.
Lauren
> -----Original Message-----
> From: techwr-l-bounces+lt34=csus -dot- edu -at- lists -dot- techwr-l -dot- com
> [mailto:techwr-l-bounces+lt34=csus -dot- edu -at- lists -dot- techwr-l -dot- com] On
> Behalf Of Tsipi Erann
> Sent: Monday, August 20, 2007 2:16 AM
> To: techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: To Gerund or Not to Gerund?
>
> I'm in the process of adapting/creating a style guide for a
> company that
> recently went through an M&A process.
>
> We have become VERY stuck on the question of the format for procedure
> headings: The common practice I'm familiar with is to use a
> gerund format
> ("Adding Files to the Database"). The other proposal was to
> use present
> simple verbs ("Add Files to the Database").
>
> Writers/editors on the "other" side have a bias against
> gerund use, because
> of localization issues (although everyone pretty much agrees
> that consistent
> usage overcomes translation issues).
>
> Writers/editors on "this" side are against present simple,
> because a) it
> looks the same as an imperative, and can therefore be
> confused with a step,
> which leads to b) if our goal is to be DITA compatible, each
> architectural
> element should be different, hence a heading must be
> different than a step.
>
> After the long intro, here are my questions:
>
> 1. What is your opinion on the issue?
> 2. What style guide do you use/champion regarding procedure headings?
> 3. Do you have a good alternative to both gerunds and present
> simple? (one
> suggestion was a "How To" statement, which some style guides
> [Microsoft]
> prohibit... Do you know why they do?)
>
> THANKS!
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> 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 lt34 -at- csus -dot- edu -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/lt34%40csus.edu
>
>
> 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-
