Publication guidelines - sharing, seeking suggestions & improvements

[Tim Mantyla <TimMantyla -at- nustep -dot- com>]

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 
www.techwr-l.com/node/26/print)
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
Template
        Need for template
Help and support resources
Contacts

Section 4       Resources
Reference sources
        Style guides
        Dictionaries
                English
                Medical/technical
                Other languages
        Thesauri
        Encyclopedias
        Quotations
 
Whodunit ? list of publication contributors and principals 
Online non-reference resources
        Email lists, discussion groups
        Technical websites and other resources

-----------

Thanks,

Tim Mantyla
Communications Associate
NuStep, Inc.  -  www.nustep.com
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.
http://www.DocToHelp.com/TechwrlList

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

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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
http://www.techwr-l.com/ for more resources and info.