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

Re: Scoping a DocumentationProject??

Subject: Re: Scoping a DocumentationProject??
From: "Melissa Nelson" <melmis36 -at- hotmail -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Thu, 05 Jan 2006 14:27:05 -0500

Ugh I really hate getting into this discussion.... but I have to say as a tech writer I have done documents where my focus is on the audience (User Guides etc) and purely technical documents where my focus is purely on the system (STD's etc). I think the focus of the document is determined by the type of document.
Melissa





From: Beth Agnew <beth -dot- agnew -at- senecac -dot- on -dot- ca>
Reply-To: beth -dot- agnew -at- senecac -dot- on -dot- ca
CC: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: Scoping a DocumentationProject??
Date: Thu, 05 Jan 2006 14:29:20 -0500

Yes, Tony, this is exactly what we've been trying to convey. In a community of techwriters we are very focused on our audience, our end user. We come at all communication problems with that end in mind: how does this help my reader use and enjoy this product? We always start a project by thinking about the audience. The engineering folks start by thinking about the system. Both communities are needed to make a product work for the customer. Emphasis on one point of view to the exclusion of the other creates problems for the user. Systems-only focus leaves a legacy of hard-to-understand documentation. Techwriters are user advocates, we think and speak user, not system. It is not surprising that the requirements engineering community does not do this. That is not their primary role.

In a great development company, you have systems analysts, business analysts, and techwriters working together to figure out how the *system *can help the *user *do their *business*. Our profession has long argued whether someone should be an engineer first before becoming a techwriter so that they can understand the system, or whether they should be a plain language/communication expert first so they can explain the system. That debate will *never *be resolved because both are viable and valuable ways of approaching documentation. Each user community, each product, has its own needs and challenges. Techwriters tackle them all. That's why we are such a diverse group. There's a place in the profession for everyone who wants to be here, no matter what their background, because ultimately it's all about helping the user have a better experience with the product, process, policy, or service.

--Beth

Tony Markos wrote:

I am aware of what the requirements engineering community does, but,
not how the Tech Writer community does it. The two
communities sometimes do the same basic things in
radically different fashion.

--
Beth Agnew
Professor, Technical Communication
Seneca College of Applied Arts & Technology
Toronto, ON 416.491.5050 x3133
http://www.tinyurl.com/83u5u

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

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l

Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author content and configure Help in MS Word or any HTML editor. No proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to TECHWR-L as melmis36 -at- hotmail -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/melmis36%40hotmail.com

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.


_________________________________________________________________
On the road to retirement? Check out MSN Life Events for advice on how to get there! http://lifeevents.msn.com/category.aspx?cid=Retirement

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

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l

Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author content and configure Help in MS Word or any HTML editor. No proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -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%40infoinfocus.com

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.

Previous by Author: Thanks for all the replies
Next by Author: Re: Friday Poll Idea (WAS: In love with a word)
Previous by Thread: RE: Scoping a DocumentationProject??
Next by Thread: RE: Scoping a DocumentationProject??

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

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

Sponsored Ads