RE: Narrative Technical Writing

Subject: RE: Narrative Technical Writing
From: "Janoff, Steve" <Steve -dot- Janoff2 -at- Teradata -dot- com>
To: "Mike McCallister" <mike -dot- mccallister -at- pkware -dot- com>, "voxwoman" <voxwoman -at- gmail -dot- com>, "Robert Lauriston" <robert -at- lauriston -dot- com>
Date: Tue, 3 Nov 2009 16:52:55 -0500

Wow. Thanks for sending this on, Mike. Will be interesting to scan, at
least.

This seems to have been written by enthusiasts/developers rather than
tech writers.

Looks like there's going to be a need for tech writers for a
LOOOOOOOONNNNNNNNNNNNNNGGGGGGGGGGGGGGG time, judging by this. :)

Man, I don't know about you, but I would just *dread* confronting a
manual like this. I sort of get the feeling that the product is
exciting but you kind of can't tell it from this doc.

Where's the minimalist version? :)

Steve

-----Original Message-----
From: techwr-l-bounces+steve -dot- janoff2=teradata -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+steve -dot- janoff2=teradata -dot- com -at- lists -dot- techwr-l -dot- com]
On Behalf Of Mike McCallister
Sent: Tuesday, November 03, 2009 12:55 PM
To: voxwoman; Robert Lauriston
Cc: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: Narrative Technical Writing

Funny you should mention Google Wave. This just came out over the
weekend:

http://completewaveguide.com/

...and yes, it will be a book too.



Mike McCallister
Document Architect
PKWARE, Inc.

-----Original Message-----
From: techwr-l-bounces+mike -dot- mccallister=pkware -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+mike -dot- mccallister=pkware -dot- com -at- lists -dot- techwr-l -dot- com]
On Behalf Of voxwoman
Sent: Tuesday, November 03, 2009 12:47 PM
To: Robert Lauriston
Cc: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: Narrative Technical Writing

Not too many. What I see happening is that someone figures it out and
then posts instructions to their FB friends. These instructions get
reposted in a viral fashion.

Google Wave is using instructional videos, which I'd rather be reading
instead of watching/listening. But I suppose for an increasingly
illiterate society, videos are a better way to go. ("Illiterate" in the
sense that people actively avoid having to read a lot of text - which is
what I see in the current crop of teenagers that I'm exposed to). They
could benefit from a glossary, as they are using "wave" and "blip" (and
other terms) in new and not contextually comprehensible ways.

-Wendy

On Tue, Nov 3, 2009 at 1:39 PM, Robert Lauriston
<robert -at- lauriston -dot- com>wrote:

> How many users can figure out how to configure Facebook "Friend Lists"
> and privacy settings so as to share different information with
> friends, family, and professional contacts without consulting some
> extra-Facebook documentation? How many can figure it out even then?
>
> I just documented a purchasing application based on a subset of Oracle

> Financials. I did write a one-page cheat sheet for end users, but it
> took more like 25 pages to cover all the tasks four groups of users
> with different privileges regularly have to perform.
>
> On Tue, Nov 3, 2009 at 10:14 AM, Janoff, Steve
> <Steve -dot- Janoff2 -at- teradata -dot- com> wrote:
> > ... Web applications are becoming so easy to use, the eventual
"help"
> might
> > be a 1-page cheat sheet. ...
> >
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Are you looking for one documentation tool that does it all? Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at:
http://www.doctohelp.com/

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.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 -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


Follow-Ups:

References:
Re: Narrative Technical Writing: From: Chris Despopoulos
RE: Narrative Technical Writing: From: Janoff, Steve
Re: Narrative Technical Writing: From: Robert Lauriston
Re: Narrative Technical Writing: From: voxwoman
RE: Narrative Technical Writing: From: Mike McCallister

Previous by Author: RE: Narrative Technical Writing
Next by Author: RE: Doc Design and Convention ( was TECHWR-L Digest, Vol 48, Issue 27)
Previous by Thread: RE: Narrative Technical Writing
Next by Thread: RE: Narrative Technical Writing


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

Sponsored Ads


Sponsored Ads