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.
Randy -- I make a distinction between document design and mechanical style.
For example, most style guidelines pertain more to mechanical style than to
writing style. Mechanical style involves such things as punctuation,
capitalization, representation of numbers, margin size, fonts, headers and
footers, cross references, and conventions for using uppercase, bold, and
italics. Document design, on the other hand, involves format (the arrangement
or layout of information) and creating publications that are both visually
distinct and attractive. For example, some specific document design goals
include finding the best way to:
- distinguish primary from secondary topics
- set off figures and examples from the text
- use retrievability aids so that readers can find information easily
- arrange every element to lead the eye progressively from one part
to the next
- promote readers' acceptance of the information
- provide visual reliev
- make information accessible to diverse audiences.
Writing style, of course, includes other considerations, such as omitting
needless words, writing in active voice, organizing information into "chunks"
that build upon each other, using consistent terminology, defining acronyms
or abbreviations the first time they are used, and creating task-oriented
information.
Hm-m-m-m-m ... I just noticed a typo in the list of doc. design goals, but
this lousy editor won't let me go back & fix it ....
Anyway, I hope this info helps you develop your course. BTW, since I'm also
a professional indexer, I place a lot of importance on retrievability.
Although the index is perhaps the most important retrievability aid, there
are lots of document design principles that contribute to retrievability as
well.
Lori Lathrop
Lathrop Media Services
(currently on contract assignment
to the U.S. Fish & Wildlife Service)