TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
RE: Typical contents for a best practices guide and examples avai labl e online
Subject:RE: Typical contents for a best practices guide and examples avai labl e online From:Peter Kelly <peter_kelly -at- sockeyesolutions -dot- com> To:"'hbacheler -at- aol -dot- com'" <hbacheler -at- aol -dot- com>, Peter Kelly <peter_kelly -at- sockeyesolutions -dot- com>, techwr-l -at- lists -dot- techwr-l -dot- com Date:Wed, 8 Mar 2006 18:23:03 -0500
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: hbacheler -at- aol -dot- com [mailto:hbacheler -at- aol -dot- com]
Sent: Wednesday, March 08, 2006 06:14 PM
To: peter_kelly -at- sockeyesolutions -dot- com; techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: Typical contents for a best practices guide and examples
availabl e online
It depends on the type of 'best practices' that you are looking for.
Be more specific. It might help
Harry
-----Original Message-----
From: Peter Kelly <peter_kelly -at- sockeyesolutions -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Sent: Wed, 8 Mar 2006 17:52:45 -0500
Subject: Typical contents for a best practices guide and examples
availabl e online
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. Could someone recommend a few that are available online that
they
think are good examples of the species? Also thoughts on what typically
goes
into a best practices guide for software or a link to the thread where
it
was discussed.
Thanks so much!
Peter
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
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