Creating Documentation With A Wiki: DITA Storm Project Innovative Technology Track
Overview Background Basics: DITA, DITA Storm, Wiki Structure in wiki content DITA – wiki integration Takeaways
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>
DITA Storm Editor XML Editor Browser-based WYSIWYG DITA-aware …
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”
Wiki Has Some Clear Advantages Easy viewing Easy navigation Easy editing Easy collaboration Versioning Less developed but also available Workflow Authorization Authentication Content reuse … 1.5M articles 2,000 new articles per day 15,000 active editors 206 languages
Wiki Features Discussion Versioning Reviewing
Problem: Content Is Unstructured Difficult to edit Difficult to publish Difficult to reuse
… is it truly unstructured?
More Examples…
Most of Wiki Content Is Structured Topics References Concepts Tasks
DITA + wiki DITA is asking to be integrated into wiki Adding structure to simplicity
Adding Structure to What’s Out There Basic DITA Integration Easily achievable Deep DITA Integration Difficult Wiki Engines Mediawiki Twiki MoinMoin JotSpot Confluence JSPWiki
DITA Storm + wiki
DITA + wiki Excellent fit for: Development documentation Website content management Other applications
Takeaways DITA is natural Do XML/DITA conversion research now Wiki is especially good for iterative writing Structured wiki authoring in coming

Creating Documentation With A Wiki: The DITA Storm Project

  • 1.
    Creating Documentation WithA Wiki: DITA Storm Project Innovative Technology Track
  • 2.
    Overview Background Basics:DITA, DITA Storm, Wiki Structure in wiki content DITA – wiki integration Takeaways
  • 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.
    DITA Storm EditorXML Editor Browser-based WYSIWYG DITA-aware …
  • 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.
    Wiki Has SomeClear Advantages Easy viewing Easy navigation Easy editing Easy collaboration Versioning Less developed but also available Workflow Authorization Authentication Content reuse … 1.5M articles 2,000 new articles per day 15,000 active editors 206 languages
  • 7.
    Wiki Features DiscussionVersioning Reviewing
  • 8.
    Problem: Content IsUnstructured Difficult to edit Difficult to publish Difficult to reuse
  • 9.
    … is ittruly unstructured?
  • 10.
  • 11.
    Most of WikiContent Is Structured Topics References Concepts Tasks
  • 12.
    DITA + wikiDITA is asking to be integrated into wiki Adding structure to simplicity
  • 13.
    Adding Structure toWhat’s Out There Basic DITA Integration Easily achievable Deep DITA Integration Difficult Wiki Engines Mediawiki Twiki MoinMoin JotSpot Confluence JSPWiki
  • 14.
  • 15.
    DITA + wikiExcellent fit for: Development documentation Website content management Other applications
  • 16.
    Takeaways DITA isnatural Do XML/DITA conversion research now Wiki is especially good for iterative writing Structured wiki authoring in coming