Documentation conventions

Subject: Documentation conventions
From: "Prasad" <prasad -dot- yesu -at- applabs -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 19 Sep 2007 13:12:16 +0530

Dear All,

I have finished documenting a project in MS Word. Right now, the doc is
undergoing refinement. In view of this, I would like request experts to
guide me understand the conventions used in documentation (preferably
standard conventions). This is a technical document intended for end users
to understand what the product is. Keeping this exercise in view, I have
been in need of understanding few conventions. I would be thankful to you
all for providing me inputs on this concerned subject.

Kind regards,


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: TOC
Next by Author: RE: Documentation conventions
Previous by Thread: Re: Knowledge is manufactured?
Next by Thread: RE: Documentation conventions

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

Sponsored Ads