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.
> My confusion: mixing socalled best practices with procedures creates a
> Frankensteinish conglomeration. I am looking for help in how to create a
> distinction between these two concepts. Any thoughts?
One possible solution:
Section 1: The rules/procedures/whatever
Section 2. Techniques/guidelines/best practices/whatever
Section 1 just lays down the law in a form suitable for reference,
maybe with some examples to make it easier to read.
Section 2 covers various specific types of situations that come up,
and shows good ways to handle them, without insinuating that they're
the only ways. In contrast to section 1, this section is *extremely*
example-heavy, and very light on telling the reader what general
conclusion to draw. The wording is less definite, relying on phrases
like "You could try this:"
So the document distinguishes the two types of content by section, by
title, by content, and by style.
A wonderful example of this kind of breakdown is the book _The Awk
Programming Language_ by Aho, Kernighan, and Weinberger.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Free copy of ARTS PDF Tools when you register for the PDF
Conference by April 30. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.com
Are you using Doc-to-Help or ForeHelp? Switch to RoboHelp for Word for $249
or to RoboHelp Office for only $499. Get the PC Magazine five-star rated
Help authoring tool for less! Go to http://www.ehelp.com/techwr
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
