RE: Style guide and/or templates for Technical Instructions

Subject: RE: Style guide and/or templates for Technical Instructions
From: "Joe Malin" <jmalin -at- tuvox -dot- com>
To: "Paul Abbot" <datapanix -at- gmail -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 13 Feb 2006 09:50:17 -0800

One thing you might consider is looking at the software tools your
audience uses, and then going with some or all of the style decisions
those tools use. This might be different according to platform.

I agree that you want to use a small number of fonts/font styles.

I use the Microsoft Manual of Style (3rd Ed) for terminology and some
style decisions. I use Read Me First! (Sun Style Guide) for other style
decisions (page 57 is a good example of presenting typographic
conventions). I use Xerox Publishing Standards for book-related stuff,
and I use some ideas I got from Oracle for online help.


Joe Malin
Technical Writer
jmalin -at- tuvox -dot- com
The views expressed in this document are those of the sender, and do not
necessarily reflect those of TuVox, Inc.

-----Original Message-----
From: techwr-l-bounces+jmalin=tuvox -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+jmalin=tuvox -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf
Of Paul Abbot
Sent: Thursday, February 09, 2006 8:17 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Style guide and/or templates for Technical Instructions


I've been elected to create and maintain instructional documentation for
using various software development tools, like Visual Studio and
JBuilder. Most of the instructions are of the form "open C++ --> go to
File --> Click New.. --> type filename.txt" with most of the steps
requiring a checkbox-like bullet so the person following can check off
each step.

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!.

Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at

You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.

Previous by Author: RE: Techwriter in the News
Next by Author: RE: Getting started with wiki?
Previous by Thread: RE: Style guide and/or templates for Technical Instructions
Next by Thread: Re: Style guide and/or templates for Technical Instructions

What this post helpful? Share it with friends and colleagues:

Sponsored Ads