RE: Documentation conventions

Subject: RE: Documentation conventions
From: "Prasad" <prasad -dot- yesu -at- applabs -dot- com>
To: "'Chinell, David F \(GE Indust, Security\)'" <David -dot- Chinell -at- GE -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 19 Sep 2007 19:29:29 +0530

Dear Bear,

Many thanks for making me understand the question I posted. My manual is
about a software product, and as you have made it clear, I suppose Microsoft
Manual of Style or Read Me First should help me.

I have tried looking for few manuals to emulate the best of them, but
couldn't it.

I thank you once again for expressing concern to my question.

Best regards,

-----Original Message-----
From: Chinell, David F (GE Indust, Security) [mailto:David -dot- Chinell -at- GE -dot- com]
Sent: Wednesday, September 19, 2007 7:18 PM
To: Prasad; techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: Documentation conventions


Your request seems far too broad. You seem to be asking us to give you
information that could easily fill a rather large book or two. Perhaps
you really need to hire a professional editor?

If you're concerned with design and usage questions, I'd recommend you
get a copy of the Chicago Manual of Style. That's a commonly used style
guide, and will answer many questions about one "right" way to prepare a

If your manuals are about software, you could also consult the Microsoft
Manual of Style or Read Me First (the Sun style guide).

Finally, you can study and emulate the conventions used in any of the
technical publications you personally use and find valuable and

If you have questions about specific conventions (such as how to treat
the back of a page when it's blank, as before a new chapter) ask those
one-by-one, or in manageable groups.



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.


RE: Documentation conventions: From: Chinell, David F (GE Indust, Security)

Previous by Author: Documentation conventions
Next by Author: RE: Documentation conventions
Previous by Thread: RE: Documentation conventions
Next by Thread: Re: Documentation conventions

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

Sponsored Ads