Revision of Difference between referenz and concept? from Tue, 2008-10-14 14:26

Normal 0 21 false false false MicrosoftInternetExplorer4 /* Style Definitions */ table.MsoNormalTable {mso-style-name:"Normale Tabelle"; mso-tstyle-rowband-size:0; mso-tstyle-colband-size:0; mso-style-noshow:yes; mso-style-parent:""; mso-padding-alt:0cm 5.4pt 0cm 5.4pt; mso-para-margin:0cm; mso-para-margin-bottom:.0001pt; mso-pagination:widow-orphan; font-size:10.0pt; font-family:"Times New Roman"; mso-ansi-language:#0400; mso-fareast-language:#0400; mso-bidi-language:#0400;}

Hallo,

I read the DITA Architectural and Language Specification and a book about topic orientate writing, but I still have the problem, that I often don’t know if I should write content in a reference or a concept topic. The examples often do not help me because I write documentation for machines and not only for software.

How have you learned that?

One example:

During the machine is running the user have to do some activities. I have a topic with the following content (in a table):

when...           |      activity 

continuously   |       * Do...

                             * Do...

daily              |       * Do...

                             * Do...

if necessary    |       * Do...

                              * Do...

Another example:

 

I have a picture which shows a component of a machine and under the picture is a legend with the name and description of the components. Is it a concept topic because not every reader needs the information and because it is an overview of the product?

 

 

 

Nina

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