Diff for Myths about technical writing

Thu, 2008-06-12 19:12 by Bob DoyleThu, 2008-06-12 21:15 by carolgeyer
Changes to Body
Line 1Line 1
 
<p>
 
<p>
-
When you start working with DITA, there are some things that you may feel you need for traditional reasons that you won't find in DITA.
+
When you start working with DITA, there are some things that you may feel you need for traditional reasons that you won't find in DITA. Before you try to modify or specialize DITA, it may be worthwhile to rethink some technical writing practices that are outdated and not recommended today.
 
</p>
 
</p>
 
<p>
 
<p>
-
Before you try to modify or specialize DITA, it may be time to rethink some technical writing practices that are outdated and not recommended today.
+
<strong>1. The GlueText Myth</strong>
-
</p>
+
-
<p>
+
-
<strong>The GlueText Myth</strong>
+
 
</p>
 
</p>
 
<p>
 
<p>
Line 12Line 9
 
readers of what has come before or comes after a particular procedure,
 
readers of what has come before or comes after a particular procedure,
 
description, or explanation. In topic-oriented authoring, which forms
 
description, or explanation. In topic-oriented authoring, which forms
-
the basis for the DITA Model, transitional text has become problematic <a href="/do-we-really-need-all-glue">Do we really need all that glue?</a>
+
the basis for the DITA Model, transitional text has become problematic. See <em><a href="/do-we-really-need-all-glue">Do we really need all that glue?</a></em>
 
</p>
 
</p>
 
<p>
 
<p>
-
<strong>The Stem Sentences Myth</strong>
+
<strong>2. The Stem Sentences Myth</strong>
 
</p>
 
</p>
 
<p>
 
<p>
Line 22Line 19
 
task. The task stem sentence, generally consisting of a partial
 
task. The task stem sentence, generally consisting of a partial
 
sentence such as “To start the machine:” , followed by &quot;1. Plug it in.&quot;, &quot;2. Turn it on.,&quot; etc., is not supported by any
 
sentence such as “To start the machine:” , followed by &quot;1. Plug it in.&quot;, &quot;2. Turn it on.,&quot; etc., is not supported by any
-
explicit DITA element in the DITA Task information type. <a href="/wiki/stem-sentences">How to do it with DITA.</a>
+
explicit DITA element in the DITA Task information type. See <em><a href="/wiki/stem-sentences">How to do it with DITA.</a></em>
 
</p>
 
</p>
 
<p>
 
<p>
-
<strong>The Front-Matter Page-Numbering Myth</strong>
+
<strong>3. The Front-Matter Page-Numbering Myth</strong>
 
</p>
 
</p>
 
<p>
 
<p>
-
Traditional books use lower-case Roman numerals for introductory front material. This and folio-style chapter numbering, page 2-35, are deprecated practices today. <a href="http://tech.groups.yahoo.com/group/dita-users/message/10739">Why bother with hangovers from the 19th century?</a> 
+
Traditional books use lower-case Roman numerals for introductory front material. This and folio-style chapter numbering, page 2-35, are deprecated practices today. See <em><a href="http://tech.groups.yahoo.com/group/dita-users/message/10739">Why bother with hangovers from the 19th century?</a></em>
 
</p>
 
</p>
 
<p>
 
<p>
-
______________________
+
&nbsp;
 
</p>
 
</p>
 
<p>
 
<p>
-
Please add your own myths about tech writing here.
+
<em>Add your favorite technical writing myth to this page. Just <a rel="nofollow" href="/user">log in</a> and select the &quot;Edit&quot; tab above.</em>
 
</p>
 
</p>
 
 
Revision of Thu, 2008-06-12 21:15:

Myths about technical writing

When you start working with DITA, there are some things that you may feel you need for traditional reasons that you won't find in DITA. Before you try to modify or specialize DITA, it may be worthwhile to rethink some technical writing practices that are outdated and not recommended today.

1. The GlueText Myth

Glue text is defined as transitional information intended to inform readers of what has come before or comes after a particular procedure, description, or explanation. In topic-oriented authoring, which forms the basis for the DITA Model, transitional text has become problematic. See Do we really need all that glue?

2. The Stem Sentences Myth

Stem sentences in technical communication have long been considered a standard practice to introduce new content, especially steps in a task. The task stem sentence, generally consisting of a partial sentence such as “To start the machine:” , followed by "1. Plug it in.", "2. Turn it on.," etc., is not supported by any explicit DITA element in the DITA Task information type. See How to do it with DITA.

3. The Front-Matter Page-Numbering Myth

Traditional books use lower-case Roman numerals for introductory front material. This and folio-style chapter numbering, page 2-35, are deprecated practices today. See Why bother with hangovers from the 19th century?

 

Add your favorite technical writing myth to this page. Just log in and select the "Edit" tab above.

XML.org Focus Areas: BPEL | DITA | ebXML | IDtrust | OpenDocument | SAML | UBL | UDDI
OASIS sites: OASIS | Cover Pages | XML.org | AMQP | CGM Open | eGov | Emergency | IDtrust | LegalXML | Open CSA | OSLC | WS-I