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.
Scott Miller commented (re: Conventions Used section):
>
> >Waste of paper. Provides no useful information. The only useful
> >convention-type info I've seen is how to read syntax stuff, like [stuff
> >in brackets is optional], and also what language programming examples
> >are written in. Otherwise, stuff like "key names are presented in
> >all-caps bold" is self-evident.
Let me give you a different view on that. Not only do I include a
Conventions Used section for anything that might be misunderstood, but I
make a special effort to explain anything *like* a convention for the
really naive user (and there are still bucketloads of those folks out
there).
In the above paragraph, for instance, I used **'s to indicate emphasis,
since boldface would be lost in transmission. In a project I'm working
on, our HTML translation template is so severely restricted that we
can't use any boldface or any quotes. (We're coming from Frame, and
going through several levels of filters before we actually get to
HTML.) Further, we have to distinguish between THIS system, the system
from which it was derived, and the language conventions that underly
both systems, because THIS system is a joint venture between two
well-known companies. Again, we are using the Conventions Used section
to explain how things are differentiated.
