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.
> You don't say the environment or the application you're using, but if it
> is FrameMaker, you might want to consider the style templates that come
> on diskette with SUN's "A Style Guide for the Computer Industry".
Thanks, John. This must be deja-vu for you, since I also posted this to the
Framers list, and you responded there, too. :-)
I'm aware of the Adobe template paks. What I'm actually looking for is
something that details out the physical aspects of the documentation template,
the process, and the production.
Super-simplified examples would be:
--Headers will left justified 14 pt. Helvetica Bold.
--Body text will be indented 1.5inches 12 pt. Palatino.
--Graphics will be handled in the following manner: <blah> <blah> <blah>
--Reviews will be conducted at these points int he documentation process:
<blah> <blah> <blah>
--All chapters will be routed for review to the following people/departments:
<blah> <blah> <blah>
--Company logo specs are as follows: <blah> <blah> <blah> (size, color,
reproduction)
--Tone of writing will be: <blah> <blah> <blah>
--Manuals will be bound as follows: <blah> <blah> <blah>
All of the above would have written or graphical examples as necessary. I'd
also like to include a brief grammar guide for quick reference. I had a
*great* style guide about 6 years ago, but during the course of several moves
(both jobs and housing), it's disappeared.