Creating Documentation With A Wiki: DITA Storm Project Innovative Technology Track
Overview <ul><li>Background </li></ul><ul><li>Basics: DITA, DITA Storm, Wiki </li></ul><ul><li>Structure in wiki content <...
DITA Content <topic> <title>Some little topic</title> <body> <p>Here's a <b><i>cute</i></b>, <b>little</b> topic. </p> <ul...
DITA Storm Editor <ul><li>XML Editor </li></ul><ul><li>Browser-based </li></ul><ul><li>WYSIWYG </li></ul><ul><li>DITA-awar...
Wiki wiki + encyclopedia content = wikipedia wiki + dictionary content = wiktictionary wiki + quotations = wikiquote wiki ...
Wiki Has Some Clear Advantages <ul><li>Easy viewing </li></ul><ul><li>Easy navigation </li></ul><ul><li>Easy editing </li>...
Wiki Features Discussion Versioning Reviewing
Problem: Content Is Unstructured <ul><li>Difficult to edit </li></ul><ul><li>Difficult to publish </li></ul><ul><li>Diffic...
… is it truly unstructured?
More Examples…
Most of Wiki Content Is Structured <ul><li>Topics </li></ul><ul><li>References </li></ul><ul><li>Concepts </li></ul><ul><l...
DITA + wiki <ul><li>DITA is asking to be integrated into wiki </li></ul><ul><li>Adding structure to simplicity </li></ul>
Adding Structure to What’s Out There <ul><li>Basic DITA Integration </li></ul><ul><ul><li>Easily achievable </li></ul></ul...
DITA Storm + wiki
DITA + wiki <ul><li>Excellent fit for: </li></ul><ul><li>Development documentation </li></ul><ul><li>Website content manag...
Takeaways <ul><li>DITA is natural </li></ul><ul><li>Do XML/DITA conversion research now </li></ul><ul><li>Wiki is especial...
Upcoming SlideShare
Loading in …5
×

Creating Documentation With A Wiki: The DITA Storm Project

3,764 views
3,500 views

Published on

Presented at DocTrain East 2007 by Alex Karesin -- Wiki-based content authoring is gaining momentum. This simple concept provides exceptional convenience and ease of use for the editors. Ironically, benefits of free-style editing prevent it from penetrating into enterprise environments with stricter content structure and reusability requirements offered by, for example, DITA XML standard. How do you combine convenience of free style writing and advantages of structured, reusable DITA content? The concept of DITA wiki is designed to satisfy both. Alex Karezin shares his experience of creating and adopting DITA content management system that was built by integrating web-based DITA XML editor into wiki and generic CMS.

We will look at wiki platforms from structured authoring perspective; identify suitable candidates, highlight their advantages, review different levels of DITA-wiki integration and summarize efforts required to achieve it. Lastly we will address data migration, survey user experience and draw conclusions.

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

No Downloads
Views
Total views
3,764
On SlideShare
0
From Embeds
0
Number of Embeds
44
Actions
Shares
0
Downloads
82
Comments
0
Likes
1
Embeds 0
No embeds

No notes for slide
  • Creating Documentation With A Wiki: The DITA Storm Project

    1. 1. Creating Documentation With A Wiki: DITA Storm Project Innovative Technology Track
    2. 2. Overview <ul><li>Background </li></ul><ul><li>Basics: DITA, DITA Storm, Wiki </li></ul><ul><li>Structure in wiki content </li></ul><ul><li>DITA – wiki integration </li></ul><ul><li>Takeaways </li></ul>
    3. 3. DITA Content <topic> <title>Some little topic</title> <body> <p>Here's a <b><i>cute</i></b>, <b>little</b> topic. </p> <ul> <li>Some item</li> <li>Another item</li> </ul> </body> </topic> <task> <title>Restart your system</title> <shortdesc>This is standard procedure after installing any new software.</shortdesc> <taskbody> <steps> <step> <cmd>If you are on a Windows system, go to the start menu.</cmd> </step> <step> <cmd>If you are on a Linux system, contact your system administrator for assistance. You may not need to restart.</cmd> </step> … </steps> </taskbody> </task> <reference> <title>element</title> <shortdesc>Describes a single element …. </shortdesc> <refbody> <refsyn> <codeblock>&lt;!ELEMENT …&gt;</codeblock> </refsyn> <properties> <property> <proptype>string</proptype> <propvalue>name</propvalue> <propdesc>Name of the element… </propdesc> </property> ... </properties> <example> ... </example> </refbody> </reference>
    4. 4. DITA Storm Editor <ul><li>XML Editor </li></ul><ul><li>Browser-based </li></ul><ul><li>WYSIWYG </li></ul><ul><li>DITA-aware </li></ul><ul><li>… </li></ul>
    5. 5. Wiki wiki + encyclopedia content = wikipedia wiki + dictionary content = wiktictionary wiki + quotations = wikiquote wiki + ??? = wikimania … “A defining characteristic of wiki technology is the ease with which pages can be created and updated”
    6. 6. Wiki Has Some Clear Advantages <ul><li>Easy viewing </li></ul><ul><li>Easy navigation </li></ul><ul><li>Easy editing </li></ul><ul><li>Easy collaboration </li></ul><ul><li>Versioning </li></ul><ul><li>Less developed but also available </li></ul><ul><li>Workflow </li></ul><ul><li>Authorization </li></ul><ul><li>Authentication </li></ul><ul><li>Content reuse </li></ul><ul><li>… </li></ul><ul><li>1.5M articles </li></ul><ul><li>2,000 new articles per day </li></ul><ul><li>15,000 active editors </li></ul><ul><li>206 languages </li></ul>
    7. 7. Wiki Features Discussion Versioning Reviewing
    8. 8. Problem: Content Is Unstructured <ul><li>Difficult to edit </li></ul><ul><li>Difficult to publish </li></ul><ul><li>Difficult to reuse </li></ul>
    9. 9. … is it truly unstructured?
    10. 10. More Examples…
    11. 11. Most of Wiki Content Is Structured <ul><li>Topics </li></ul><ul><li>References </li></ul><ul><li>Concepts </li></ul><ul><li>Tasks </li></ul>
    12. 12. DITA + wiki <ul><li>DITA is asking to be integrated into wiki </li></ul><ul><li>Adding structure to simplicity </li></ul>
    13. 13. Adding Structure to What’s Out There <ul><li>Basic DITA Integration </li></ul><ul><ul><li>Easily achievable </li></ul></ul><ul><li>Deep DITA Integration </li></ul><ul><ul><li>Difficult </li></ul></ul><ul><li>Wiki Engines </li></ul><ul><ul><li>Mediawiki </li></ul></ul><ul><ul><li>Twiki </li></ul></ul><ul><ul><li>MoinMoin </li></ul></ul><ul><ul><li>JotSpot </li></ul></ul><ul><ul><li>Confluence </li></ul></ul><ul><ul><li>JSPWiki </li></ul></ul>
    14. 14. DITA Storm + wiki
    15. 15. DITA + wiki <ul><li>Excellent fit for: </li></ul><ul><li>Development documentation </li></ul><ul><li>Website content management </li></ul><ul><li>Other applications </li></ul>
    16. 16. Takeaways <ul><li>DITA is natural </li></ul><ul><li>Do XML/DITA conversion research now </li></ul><ul><li>Wiki is especially good for iterative writing </li></ul><ul><li>Structured wiki authoring in coming </li></ul>

    ×