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.
> As others have said, this is largely a matter
> of style. However, I do want to mention in case
> your docs are translated that our localization
> people have told us not to break infinitives
> across a list introduction because many languages
> do not use that construct and it can therefore
> cause difficulties.Therefore, they prefer
> something like:
>
> Use this feature for the following actions:
> * Eating cats
> * Killing mice
> * Riding horses
Sounds reasonable. OTOH, I've been told to avoid gerunds because
_they're_ hard to translate. :-)
I suspect Peter is correct. Competent translators should be able to
handle such common constructions in their sleep, just as they do
countless common idioms that don't translate literally into one or
another language (and non-idiomatic expressions that _should_ be
translated into an idiomatic one in some language).
Good point (made visually, not explicitly stated) that the list under
discussion should be unordered (bullets), not ordered (numbers).
As for capitalization, since it's largely a matter of style (except when
a bullet item consists of one or more complete sentences), I recommend
saving yourself a lot of grief and potential for inconsistencies by
adopting a simple, uniform rule: start all bullet items with a capital
letter, whether it's a sentence, verb phrase, noun phrase, or whatever.
IMHO, YMMV, etc.
Richard G. Combs
Senior Technical Writer
Polycom, Inc.
richardDOTcombs AT polycomDOTcom
303-223-5111
------
rgcombs AT gmailDOTcom
303-777-0436
------
Are you looking for one documentation tool that does it all? Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at: http://www.doctohelp.com/
Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at: http://www.ModernAnalyst.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-