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:To Gerund or Not to Gerund? From:"Tsipi Erann" <tsipi -dot- erann -at- gmail -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Mon, 20 Aug 2007 12:15:42 +0300
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?)
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-