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.
Subject:RE: Chattiness in manuals From:Kevin Amery <kamery -at- opentext -dot- com> To:"'david -at- farbey -dot- co -dot- uk'" <david -at- farbey -dot- co -dot- uk>, "'TECHWR-L'" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 17 Oct 2006 09:04:33 -0400
I agree, it might be appropriate for a "friendly" type of product, either
consumer related or aimed at a "hip" profession (animation, for example...
Although even there, it would have to be a particular subset of the
animation field that doesn't take itself too seriously).
If it were aimed at a professional market, though, this type of writing
probably wouldn't fit. Also, if it's dealing with the type of procedure
someone might have to do while agravated ("this @%$*^ thing is down
AGAIN!!") any writing that doesn't get straight to the point could
antagonise the user.
As is frequently the case, I think it comes down to knowing your audience.
Kevin Amery
Technical Writer, Research and Development
Open Text Corporation
1 Sparks Ave.
North York, ON. M2H 2W1
CANADA
Phone: +1 (416)496-2200-2402
e-mail: kamery -at- opentext -dot- com
Web site: http://www.opentext.com
This e-mail is protected by domestic and international copyright laws and
treaties and is the property of Open Text Corporation, it may contain
confidential and/or trade secret information of the Open Text Corporation
and/or its subsidiaries (OTC), and may be subject to legal privilege in
favor of OTC. This e-mail may only be lawfully received, accessed, displayed
on a computer screen, printed, copied, and/or used by the specific
addressee(s) named above ("Authorized Recipient") for the purpose for which
it was sent by OTC. All other rights and licenses to this e-mail are fully
reserved to OTC. If you are not an Authorized Recipient, you are required to
immediately delete this e-mail in its entirety without printing, copying,
using, and/or re-transmitting this e-mail, either in whole or in part. The
transmission of this e-mail by OTC is not to be construed as a waiver by OTC
and/or the individual sending this e-mail on behalf of OTC of any of their
respective rights or privileges at law or otherwise, howsoever arising.
-----Original Message-----
From: David Farbey [mailto:dfarbey -at- yahoo -dot- co -dot- uk]
Sent: Tuesday, October 17, 2006 7:17 AM
To: TECHWR-L
Cc: Sarah Bouchier
Subject: Re: Chattiness in manuals
Sarah Bouchier asked:
> How would you react to a manual that said, "The installation of this
> component may take several minutes. This would be a good time to go
> and get a cup of tea"?
>
> (Other than concluding that the author had run mad and needed to be
> fitted with a snazzy waistcoat with long sleeves, of course)
It depends. In some cases, that would be really inappropriate. But I can
imagine a scenario in which the manual was for a "laid-back", "cool"
product, and was deliberately designed to be friendly and whimsical in order
to fit into the atmosphere - the "branding" - that the product's owners
wanted to create, and then it would be fine. There's no rule that says user
assistance information must always be formal.
I think I'll go and have a cup of tea now. ;-)
David (in London, where tea is always appropriate!)
--
David Farbey
Information Design Consultant
david -at- farbey -dot- co -dot- uk
Office +44-(0)20-8492-7807
Fax +44-(0)20-8492-0159
Mobile +44-(0)7876-184-588
also at Clifford Sells Ltd.,
Documentation and Recruitment Specialists david -at- cliffordsells -dot- com
www.cliffordsells.com
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l
Easily create HTML or Microsoft Word content and convert to any popular Help
file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as kamery -at- opentext -dot- com -dot-
To subscribe, send a blank email to techwr-l-join -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.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l
Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-