Publication guidelines - sharing, seeking suggestions & improvements

Subject: Publication guidelines - sharing, seeking suggestions & improvements
From: Tim Mantyla <TimMantyla -at- nustep -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Thu, 12 Jun 2008 09:37:42 -0400

Hi all,

I'm producing a sales training & reference online guide for my company's
sales staff. I also decided to document the documentation with a
publication guideline. The outline is below.

One reason for creating publication guidelines is to help future
contributors. Another reason is to make our publications more consistent
internally. I did this to help them maintain the publication in a way that
best serves its readers.

It's not clear yet who will maintain the publication after it's finished,
so I couldn't involve them in producing it, as Tom H. Johnson suggests in
"Social Rules for Creating a Style Guide," included below and published on
the TECHWR-L site.

If anyone has suggestions or ideas for content or organization, I'm open.

[TITLE]: Publication Guidelines & Resources

Section 1 Contributor's guidelines
Mission & goals
Maintain the publication
Social rules for creating a style guide (by Tom H. Johnson on TECHWR-L at
Editorial conventions
English usage
Present the information ? best practices

Section 2 Style and formatting standards & conventions
Styles & formatting
Need for stylistic consistency
A template organizes & preserves styles
List of publication styles & formatting

Section 3 Software
Get started with the software
Need for template
Help and support resources

Section 4 Resources
Reference sources
Style guides
Other languages

Whodunit ? list of publication contributors and principals
Online non-reference resources
Email lists, discussion groups
Technical websites and other resources



Tim Mantyla
Communications Associate
NuStep, Inc. -
5111 Venture Drive, Suite 1
Ann Arbor, MI 48108
Email: tmantyla -at- nustep -dot- com
"Transforming Lives"

Please consider the environment before printing this e-mail

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -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 admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Previous by Author: How reliable is new Doc-To-Help 2008?
Next by Author: Yo-ho! A jolly new Olde English axiom-axing…
Previous by Thread: Re: Problems when converting RTF to FRAMEMAKER
Next by Thread: Re: TECHWR-L Digest, Vol 32, Issue 11

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

Sponsored Ads