Experts in Information Management Solutions and Services




Producing documentation for Eclipse RCP applications
        ...
Insights into problematic of SW Product
              Documentation




                                          2
Typical SW documentation deliverables:


            Printed documentation materials (manuals, references etc.)
         ...
Traditional Documentation Toolset




                                    4
Challenges we are Facing in this Scenario are:

     Dealing with different source formats and redundant content
     In...
Solution: DITA

     Single source publishing as answer to these challenges.
     Single sourcing allows:
          sam...
DITA Publication




                   7
DITAworks Toolset




                    8
Advantages of DITAworks in This Scenario

     Single-source publishing approach
     Comfortable WYSIWYG editing
     ...
Extended Eclipse Help support
 Highlights:

    Specialized DITA types for support eclipse help and contexts
    Support...
Eclipse Help Documentation Process
DEMO
   Defining and editing new Topics
   Publishing to PDF
   Publishing to Eclipse Help




                        ...
DITAworks Use Cases

  Single-source publishing
           Management of User Manuals
           Management of Technical...
New Ideas in Information Management


http://www.ditaworks.com/

 Sophienstr. 17

 D-70178 Stuttgart

 phone:      +49 (0)...
About *instinctools
   *instinctools GmbH delivers Information Management solutions on Java technology
    since 2001, on...
Upcoming SlideShare
Loading in …5
×

Producing documentation for Eclipse RCP applications using single source principle

1,208 views
1,147 views

Published on

In this presentation I highlight some basics on how DITA and DITAworks can be used when documenting Eclipse RCP applications

Published in: Business, Technology
0 Comments
0 Likes
Statistics
Notes
  • Be the first to comment

  • Be the first to like this

No Downloads
Views
Total views
1,208
On SlideShare
0
From Embeds
0
Number of Embeds
2
Actions
Shares
0
Downloads
8
Comments
0
Likes
0
Embeds 0
No embeds

No notes for slide

Producing documentation for Eclipse RCP applications using single source principle

  1. 1. Experts in Information Management Solutions and Services Producing documentation for Eclipse RCP applications using single source principle Alexej Spas, instinctools GmbH June 2010
  2. 2. Insights into problematic of SW Product Documentation 2
  3. 3. Typical SW documentation deliverables:  Printed documentation materials (manuals, references etc.)  Application help  Context sensitive help  Documentation materials that should be published online (Online help)  Training materials  Reference documentation (API docs and s.o.)  ... other documents Most of these documents have quite a high potential for partial content reuse. 3
  4. 4. Traditional Documentation Toolset 4
  5. 5. Challenges we are Facing in this Scenario are:  Dealing with different source formats and redundant content  Increasing Complexity of Documentation  Globalization & Localization  Shortening of Development Cycles  High Quality Expectations  Different Target Media  Need of Integration  Increasing Demand for Documentation Variants Conclusion: Without consistent documentation methodology and appropriate tool support there is very less chance to manage all required deliverables efficiently 5
  6. 6. Solution: DITA  Single source publishing as answer to these challenges.  Single sourcing allows:  same content to be used in different documents or in various formats.  labor-intensive and expensive work of editing only to be carried out once, on one source document.  further transformations to be performed mechanically, by automated tools.  One of the leading standards in XML single sourcing is DITA:  DITA stands for Darwin Information Typing Architecture  DITA was developed by IBM and donated to OASIS  DITA divides content into small, self-contained topics  DITA Topics can be reused in different deliverables.  Deliverables are modeled using special structure called map. 6
  7. 7. DITA Publication 7
  8. 8. DITAworks Toolset 8
  9. 9. Advantages of DITAworks in This Scenario  Single-source publishing approach  Comfortable WYSIWYG editing  Generate different formats from single source  Minimize efforts spent on managing documentation variants  Increase content reuse and minimize amount of managed content  Minimize translation costs  Increase quality and consistency of documentation  Automatically build product documentation as part of product build process  Content can be pulled from 3rd party systems  Content can be published to 3rd systems 9
  10. 10. Extended Eclipse Help support Highlights:  Specialized DITA types for support eclipse help and contexts  Support of live actions and cheat sheets  Cross-plugin links  Support of dynamic context ID mapping (DTP approach)  Eclipse help specific validations  In development (beta available): Tools for integration with development process. (Context IDs management between development and documentation teams)  Plug-in for Eclipse IDE  ID synchronization wizards 10
  11. 11. Eclipse Help Documentation Process
  12. 12. DEMO  Defining and editing new Topics  Publishing to PDF  Publishing to Eclipse Help 12
  13. 13. DITAworks Use Cases Single-source publishing  Management of User Manuals  Management of Technical and product documentation  Context sensitive help and online help  Training and e-Learning materials Structured document generation & management  Contracts, Reports  RFO, RFT and other structured documents  Include data from external data sources (DBs, management systems and s.o.) Supported output formats: XHTML, PDF, RTF, EclipseHelp, JavaHelp, troff, DocBook, SCORM* *Additional information types and output formats can be defined using modeling functionality 13
  14. 14. New Ideas in Information Management http://www.ditaworks.com/ Sophienstr. 17 D-70178 Stuttgart phone: +49 (0) 711 - 99 33 85 90 fax: +49 (0) 711 - 99 33 85 99 e-mail: info@instinctools.com internet: www.instinctools.com 14
  15. 15. About *instinctools  *instinctools GmbH delivers Information Management solutions on Java technology since 2001, on Eclipse since 2007 Germany (Stuttgart)  Eclipse Application Design and MD Project Partner R&D Management Implementation Services Management Management Customer Sales Support  Eclipse Application Maintenance and Consulting Support Implementation Technical Product Partners  Tools for Technical Documentation Management Development Project Services (single source strategies) Belarus (Grodno)  Management Team in Germany, Software Lab near shore (Belarus)  Successfully serving premium customers like Daimler, Hubert Burda Media, Garant, EnBW and SMEs  Proven management processes and reliable project delivery infrastructure  Member of tekom, Eclipse Foundation 15

×