Creating Documentation With A Wiki: The DITA Storm Project
Download as PPT, PDF2 likes1,694 views
The document discusses the integration of DITA (Darwin Information Typing Architecture) with wiki technology to enhance documentation processes. It outlines the advantages of using wiki systems for structured content editing and management, including ease of viewing, navigation, and collaboration. The integration aims to add structure to otherwise unstructured wiki content, making it suitable for various applications like development documentation and content management.
Creating Documentation With A Wiki: The DITA Storm Project
- 1. Creating Documentation With A 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><!ELEMENT …></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 Editor XML 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 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
- 7. Wiki Features Discussion Versioning Reviewing
- 8. Problem: Content Is Unstructured Difficult to edit Difficult to publish Difficult to reuse
- 9. … is it truly unstructured?
- 10. More Examples…
- 11. Most of Wiki Content Is Structured Topics References Concepts Tasks
- 12. DITA + wiki DITA is asking to be integrated into wiki Adding structure to simplicity
- 13. Adding Structure to What’s Out There Basic DITA Integration Easily achievable Deep DITA Integration Difficult Wiki Engines Mediawiki Twiki MoinMoin JotSpot Confluence JSPWiki
- 14. DITA Storm + wiki
- 15. DITA + wiki Excellent fit for: Development documentation Website content management Other applications
- 16. Takeaways DITA is natural Do XML/DITA conversion research now Wiki is especially good for iterative writing Structured wiki authoring in coming