RE: Typical contents for a best practices guide and examples avai labl e online

[Peter Kelly <peter_kelly -at- sockeyesolutions -dot- com>]

The original idea was to collect standards for application development using
our software, a goal I thought would be better served with a best practices
guide.  Several people I have spoken to have highly recommended the IBM red
books.

I would expect a 'Best Practices' Guide to contain:

**Specific patterns--design or development patterns-- which might be
applicable to a given situation--when using our software to create
applications
**Example usages (of the software)
**A few use case stories which illustrate the best way of using the software
in certain situations. 

-----Original Message-----
From: Steven Brown [mailto:stevenabrown -at- yahoo -dot- com]
Sent: Thursday, March 09, 2006 08:30 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: Typical contents for a best practices guide and examples
availabl e online


Peter,

To better answer your question, where did the idea of
a "best practices" guide come from? What is the intent
of such a document?

I ask because "best practices" means many different
things to different people. I've see the term used to
describe standard procedures, hints and tips,
recommendations, process overviews, etc. It's better
to first understand the information needs of your
readers and then define the document type from there.

Steven Brown




--- Peter Kelly <peter_kelly -at- sockeyesolutions -dot- com>
wrote:

> Hello all,
> 
> I know this topic came up not long ago, and I
> searched--yes somewhat
> quickly-- the archives but have not seen any
> examples of links to best
> practices guides posted. Yes I have come across a
> few on the internet but
> can't help but thinking someone on this list knows
> of a particularly good
> example.

__________________________________________________
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 

Doc-To-Help includes a one-click RoboHelp project converter. It's that easy.
Watch the demo at http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to TECHWR-L as
peter_kelly -at- sockeyesolutions -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/peter_kelly%40sockeyesolu
tions.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.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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 

Doc-To-Help includes a one-click RoboHelp project converter. It's that easy.  Watch the demo at 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.