Re: creating a department style guide

Subject: Re: creating a department style guide
From: Jean Weber <jean -at- wrevenge -dot- com -dot- au>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 25 Oct 2001 13:55:28 +1000

Nancy Mignone asked what she should put into a departmental style guide, and in what form to present it.

Nancy, this brief summary might help you get started:
http://www.wrevenge.com.au/edcourse/guides.htm

If your department creates online help, you might also be interested in my book (see sig), which includes an appendix on developing specifications for help projects; much of this material might go into a style guide.

Could it be a template with defined styles and formatting with verbiage under each style defining what it should be used for?

A template might be part of your style guide (or more likely a separate item associated with a style guide), but unless your department produces only one sort of document, one template would not be enough. Most issues will cross the boundaries between templates, but some issues might be specific to one type of document.

Regards, Jean
Jean Hollis Weber
mailto:jean -at- wrevenge -dot- com -dot- au
The Technical Editors' Eyrie http://www.wrevenge.com.au/
------------------
Still available: Editing Online Help, a tool-independent introduction to
planning, developing, and editing online help systems. For a table of
contents, go to: http://www.wrevenge.com.au/bookshop/olhbk.htm


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Announcing new options for IPCC 01, October 24-27 in Santa Fe,
New Mexico: attend the entire event or select a single day. For details and online registration, visit http://ieeepcs.org/2001

Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.


References:
creating a department style guide: From: Nancy Mignone

Previous by Author: RE: Secretary Proofing Manuals?
Next by Author: documentation evaluation
Previous by Thread: creating a department style guide
Next by Thread: Re: creating a department style guide


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

Sponsored Ads


Sponsored Ads