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.
Subject:Re: Writing structured content [recap From:jlshaeffer -at- aol -dot- com To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Sat, 23 Jun 2007 20:52:59 -0400
But writers who are not used to writing Self-contained topics (ones used to long, flowing prose composed inside a hierarchical structure, perhaps) will need to be retrained. To write modular text requires that one learn to think "notÂoutside the box."
Some words, sentences and paragraphs can violate this "self-containment" design.
Jim Shaeffer
-----Original Message-----
From: Richard Lewis <tech44writer -at- yahoo -dot- com>
To: Fred Ridder <docudoc -at- hotmail -dot- com>; quills -at- airmail -dot- net; Gordon -dot- McLean -at- GrahamTechnology -dot- com; techwr-l -at- lists -dot- techwr-l -dot- com
Sent: Sat, 23 Jun 2007 5:31 pm
Subject: RE: Writing structured content [recap]
Self-Contained Topics = Loosely Coupled and Highly Cohesive Topics =
odularized Topics. Properly modularized text can be used in different topics,
ssembled in different ways, and still makes sense.
The task at hand is not to write in a structured fashion (minor formatting
ssues aside). This implies black magic and some sort of artsy-craftsy
ntuition.
The task is, through analysis, to come up with a properly structured
nderstanding of what the product is to do, and then to use this understanding
o guide the writing process. Words, sentences, and paragraphs to ultimately
ome into play. But they are not the major hurtle in effective structured
riting.
Richard Lewis
red Ridder <docudoc -at- hotmail -dot- com> wrote:
No, the question is how to train writers how to think outside the
ook and learn how to write self-contained topics that can be
sed in different contexts and assembled in different ways and
till make sense. Not everything is a question of analysis. Ultimately
he information still has to be expreessed in words and sentences
nd paragraphs and tables and illustrations so that communication
an (possibly) occur.
________________________________________________________________________
AOL now offers free email to everyone. Find out more about what's free from AOL at AOL.com.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
