TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Both Apple and IBM make their style guides available online at no charge.
These should help you. For larger conventions in technical fields, The Style
Manual of the American Psychological Association (APA) is probably better
than Chicago, which has its pluses and minuses.
On 9/19/07, Prasad <prasad -dot- yesu -at- applabs -dot- com> wrote:
>
>
> 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
>
> Prasad:
>
> 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
> publication.
>
> 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
> professional-looking.
>
> 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.
>
> Bear
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> 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<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
> capdev -dot- communications -at- gmail -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/capdev.communications%40gmail.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 . Visit
>http://www.techwr-l.com/ for more resources and info.
>
>
--
Patricia Egan
P. O. Box 194391
San Francisco, CA 94119-4391
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-
