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: To Gerund or Not to Gerund? From:Janice Gelb <Janice -dot- Gelb -at- Sun -dot- COM> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Tue, 21 Aug 2007 14:19:06 +1000
Tsipi Erann wrote:
>
> 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?)
>
The Sun style guide calls for procedure headings
to start with "To" or "How to" and headings for
general sections that are conceptual or explanatory
to use a gerund. For example:
Creating a Database
To Establish the Database Structure
To Save the Database
Modifying Your Database
To Add or Delete Fields
To Change the Field Notation
To Rearrange Field Order
Our localization group is fine with this practice.
-- 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 archive -at- web -dot- techwr-l -dot- com -dot-