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.
Structure does not depend on a set of text-processing (Bookie, SGML, HTML,
XML) tags. The last 2 places I've been used Word styles to define structure,
along with an understanding of when to apply those styles. Structure depends
more on an acceptance of certain recurring, repeatable elements in a doc,
and rigourously writing with those elements in mind.
For example, at my previous job, we developed a set of fixed elements that
could apply to almost any given topic: Concept (basic information), Syntax
or Procedure (depending on whether you were coding or clicking), Reference
(additional "oh by the way" stuff, eg "don't do this under a Fool Moon,
unless you sacrifice a black chicken beforehand), and Example. Applying this
set of elements to a topic helped me turn a morass of text into bite-sized
pieces of information. And the structure of the elements were pretty
obvious--you dont explain a detail of something before you explain the basic
idea, you don't give an example of syntax before you give the general syntax
code. Which, otoh, is not to say that every topic had every element; fluffy
Intro chapter stuff, for example, was mostly Concepts and Examples. And
generally, a Procedure would not use Command Syntax style, nor would a
Syntax element generall use a numbered list. we applied those elements using
predefined Word styles. which our Online folks used to generate WinHelp and
>How would you suggest defining document structure
>for documents that will never be cast in XML or