[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: "Nilesh Jahagirdar" <nilesh -dot- jahagirdar -at- gmail -dot- com>
To: "Zsuzsa Nagy" <zsuzsa_nagy -at- yahoo -dot- com>
Date: Wed, 30 Aug 2006 15:39:44 +0530

While the documentation as a category seems to be a single project, I think
you are looking at creating muliple documents focusing on different things.

If that's the case, go with Best Practices, and identify further categories
for the documentation: existing market review / analysis, Standards, etc.
These categories could be based on content-wise focus, or on in what form
the documents will see the light of day.

On 8/30/06, Zsuzsa Nagy <zsuzsa_nagy -at- yahoo -dot- com> wrote:


What about calling these docs white papers?

Cheers,
Zsuzsa Nagy


> ------------------------------
>
> Message: 2
> Date: Mon, 28 Aug 2006 19:40:38 -0400
> From: "Chris Orr" <got2940 -at- hotmail -dot- com>
> Subject: Type of documentation?
> To: techwr-l -at- lists -dot- techwr-l -dot- com
> Message-ID:
> <BAY20-F2CEB332F7D7CFC07D31FFBC380 -at- phx -dot- gbl>
> Content-Type: text/plain; format=flowed
>
> 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. This type of
> documentation is heavily informed
> by research into best practices, standards, the
> existing market, feedfback
> from consultants in the field, and such.
>
> Our manager calls this documentation "best
> practices," but it's more than
> that. What would you call it?
>
> Thanks,
> Chris Orr
>
>


__________________________________________________
Do You Yahoo!?
Tired of spam? Yahoo! Mail has the best spam protection around
http://mail.yahoo.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 nilesh -dot- jahagirdar -at- gmail -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/nilesh.jahagirdar%40gmail.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.




--
But hang on, there's music and art and things to tell you about yet!
Arrrggghhh!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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:
Re: Type of documentation?: From: Zsuzsa Nagy

Previous by Author: New job profile..some questions.
Next by Author: Maintaining content between intranet site and CHM file
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