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 actually received a document like that this morning. It was a total
train wreck! Not only were there spaces used to align text (a personal
pet peeve of mine), no style was used to deal with a numbered list. And
the list was done in "Comment Text" when our company has and uses a very
clearly defined style for numbered lists. The scary part is that this
document repeated the number two. (The numbering was "1, 2, 2, 3) This
has been through at least 6 revisions and the writer didn't catch the
error. Can you all feel me cringing?
-----Original Message-----
From: Cloy Tobola [mailto:cloy -dot- tobola -at- ndsu -dot- edu]
Sent: Wednesday, February 28, 2007 12:43 PM
To: Shannon Wade
Cc: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: (no subject)
Shannon Wade asked:
> ...snip...
> Can anyone tell me why I shouldn't have blank paragraphs
> or shed ANY light on the other issue?
> ...snip...
Shannon,
You would avoid extra paragraphs for the same reason you avoid wordiness
-- it's extra, meaningless content that clutters your document.
If you needed to force a page break, you would not do it by inserting
unnecessary words to make a paragraph longer. Same thing with line
breaks. Use formatting tools to format your document, not superfluous
content.
The other reason not to use extra line breaks is that they mess up the
format if the document settings (e.g., margins, headers, footers,
gutters) change. This can happen if you move to a different computer or
change printers.
Once you've had to reformat a document where someone has done this,
you'll see what a colossal pain in the keister it can be. Other "foolish
formatting" I've seen include...
-manually inserting periods to create a "dot leader" (like you'd use
in a table of contents)
-using spaces to align or center text
-using tabs to create columns
-people still putting two spaces between sentences
Excelsior! -Cloy
=================================
Cloy Tobola
ITS Communications Coordinator
Information Technology Services
North Dakota State University
=================================
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-