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.
> I'm working on a document that has a very good Introduction
> -- except for one thing that I can't quite decide about. Some
> of the sentences are awfully long. Would you break up or
> reorganize these sentences? (I'm changing the topic in these
> examples):
>
> The Sunshine program spans all areas of personal homebuilding
> efforts -- permit authorization through post-construction
> inspection and reporting -- ensuring comprehensive,
> documented compliance for any builder to all local and state
> regulations.
The first one can -- and should, IMO -- easily be made into two
sentences:
The Sunshine program spans all areas of personal homebuilding efforts --
permit authorization through post-construction inspection and reporting.
It ensures builders of comprehensive, documented compliance to all local
and state regulations.
> The Sunshine program delivers several immediate benefits,
> including improved verification of a builder's construction
> practices, reduced paperwork, streamlined communications, and
> comprehensive review and alerts to avoid State-imposed fines.
This one cries out for a colon after "including," with the rest turned
into bullet items. Why do you thing that's inappropriate for an
introductory section? I think it's highly appropriate.
Richard
------
Richard G. Combs
Senior Technical Writer
Polycom, Inc.
richardDOTcombs AT polycomDOTcom
303-223-5111
------
rgcombs AT gmailDOTcom
303-777-0436
------
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-