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

Re: Type of documentation?

Subject: Re: Type of documentation?
From: Ned Bedinger <doc -at- edwordsmith -dot- com>
To: "List,Techwriter" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 29 Aug 2006 14:19:43 -0700

Chris Orr wrote:

I am trying to come up with a good name for the type of documentation I have been working on lately, but I'm not getting very far. Here's a description of it.

Where our release documentation has a narrow focus on specific products, this documentation has a wide focus on tasks or processes that span multiple products. It is published independently of product releases, to the company knowledgebase and/or online magazine. There is a possibility it could be published in trade magazines.
Who is the audience? Based on your remarks, my guess is you're working on a big marketing piece directed at technical staff, purchasing managers, ops managers, and everyone else who would be involved or interested in knowing more when considering your products.

This type of documentation is heavily informed by research into best practices, standards, the existing market, feedfback from consultants in the field, and such.

Best practices in a melange of standards, market research, and consultant feedback, hmmm. This could cast it as something more than a backgrounder in support of best practices. Without any more information I would probably say white paper. That's my WAG and I'm sticking to it.

Good luck.

Ned Bedinger
doc -at- edwordsmith -dot- 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 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.

References:
Type of documentation?: From: Chris Orr

Previous by Author: Re. Editing test on my website
Next by Author: New job profile..some questions.
Previous by Thread: Re: Type of documentation?
Next by Thread: RE: Type of documentation?

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

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

Sponsored Ads