[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: Style guides for software user manuals

Subject: Re: Style guides for software user manuals
From: Barry Campbell <barry -dot- campbell -at- gmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 7 Mar 2005 07:38:51 -0500


On Mon, 7 Mar 2005 11:49:11 +0100, Patrick Wright <pdoubleya -at- gmail -dot- com> wrote:

> I have been looking around for style guides for user's manuals for GUI
> software applications.

I have found both of the following books to be quite useful:

Read Me First! A Style Guide for the Computer Industry
by Sun Technical Publications, Mountain View, CA
Second edition, 384 pages; ISBN 0-13-142899-3
http://www.sun.com/books/catalog/sun_tech_pub.xml?section=Table%20of%20Contents

Microsoft Manual of Style for Technical Publications, Third Edition
Published 06/02/2004; ISBN 0-7356-1746-5
http://www.microsoft.com/MSPress/books/6074.asp

Since you're in Berlin, I'll note that they can both be found at amazon.de.
(Sun guide: http://www.amazon.de/exec/obidos/ASIN/0131428993)
(Microsoft guide: http://www.amazon.de/exec/obidos/ASIN/0735617465/)

Also, Apple's Style Guide (2003 version) is on their Web site as a
PDF, for free:
http://developer.apple.com/documentation/UserExperience/Conceptual/APStyleGuide/AppleStyleGuide2003.pdf

- bc

--
Barry Campbell <barry -dot- campbell -at- gmail -dot- com>
http://enrevanche.blogspot.com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo:
http://www.webworks.com/techwr-l

Doc-To-Help 7.5 Professional: New version with new features, improved performance and reliability, plus much more! Download your free trial today at www.componentone.com/techwrlfeb.

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.


References:
Style guides for software user manuals: From: Patrick Wright

Previous by Author: Re: Open Office Writer - Outline available?
Next by Author: Re: So nobody else has heard of UI-driven system documentation either?
Previous by Thread: Re: Style guides for software user manuals
Next by Thread: Re: Style guides for software user manuals

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

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

Sponsored Ads