Creating Documentation With A Wiki: The DITA Storm Project

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> Here's a cute, little topic. <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><!ELEMENT …></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