Technical documentation: Before migrating your files to DITA, you should clean them and eliminate redundant and unnecessary content: meta-text, stem sentences, useless 'general information', etc. - Provide clear, concise, user-friendly procedures - Skip useless screenshots and warning messages
16. Stem sentences
•
To introduce the steps in a task
- steps won’t correctly start
renumbering with 1)
(J.Hackos)
• Do We Really Need All that Glue?
- transitional text, advance
organizers,
text between topics ?
(J. Hackos, DITA.xml.org)
21. Warning = instructions
Cleaning the oxygen tubes
Make sure the oxygen tubes are fully clean.
Oxygen, oil or grease make an explosive mixture.
1. Select the Maxi-brush
2. Perform a first cleaning with the Maxi-Brush
3. With the pressure-cleaner, perform a 2nd cleaning.
29. Eclipse and CDT (continued)
1.1 Run the Eclipse and CDT installation for Windows
The CDT software is required if you are developing in C and/or C++, but not for Java
development.
1. Download the appropriate Windows version of Eclipse Ganymede from the site XXX
2. Download the CDT software:
(a.1) Download the appropriate CDT version from the Site ZZZ
(a.2) Follow the installation instructions on the site
-or(b.1) Inside Eclipse, select Help-->Software updates
(b.2) Under the Available Software tab, select the appropriate CDT versioin
(b.3) Follow the Eclipse installation instructions.
1.2 Add the language compilers
• Select the compilers for the language/languages you are using.
1.3.Install the Rational Rhapsody Developer for C and/or C++
30. Entering text
1. Start programming with the TM/ST key
2. Press the job code number
3. Press the XYZ key.
The cash register is ready for text entry
31. DITA ready: Hand-over to the migration team!
Documentation
volume – 50%
High re-use
rate
Localization
costs – 80%