Loading…

Flash Player 9 (or above) is needed to view presentations.
We have detected that you do not have it on your computer. To install it, go here.

Like this presentation? Why not share!

Documenting with DITA in Drupal

on

  • 2,563 views

In this presentation I explain how an organization can use a 3-step architecture to involve all the stakeholders of the production process in the development of DITA documentation. The architecture ...

In this presentation I explain how an organization can use a 3-step architecture to involve all the stakeholders of the production process in the development of DITA documentation. The architecture adds a community portal both upstream and downstream of the documentation team. The upstream and downstream portals can plug into the existing tools and processes of the documentation team through the use of DITA documentation topics and maps.

As a result more people are involved in the process without having to buy additional licenses of (expensive) specialized XML editors and/or CMS's.

Watch the video at http://www.pronovix.com/leveraging-communities-improved-dita-documentation-process-drupal

Statistics

Views

Total Views
2,563
Views on SlideShare
2,560
Embed Views
3

Actions

Likes
1
Downloads
22
Comments
0

1 Embed 3

http://www.linkedin.com 3

Accessibility

Categories

Upload Details

Uploaded via as OpenOffice

Usage Rights

CC Attribution-ShareAlike LicenseCC Attribution-ShareAlike License

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment

Documenting with DITA in Drupal Documenting with DITA in Drupal Presentation Transcript

  • Documenting products with DITA in DRUPAL Kristof Van Tomme [email_address]
  • Developers Managers Product owners Documentation professionals Sales Support Managers End-users
  • Developers Managers Product owners Documentation professionals Sales Support Managers End-users
  • Developers Managers Product owners Documentation professionals Sales Support Managers End-users
  • Developers Managers Product owners Documentation professionals Sales Support Managers End-users MODULAR 3-STEP PROCESS
  • Modular 3-step process
  • Developers Managers Product owners Documentation professionals Sales Support Managers End-users UPSTREAM
  • Collecting and reusing artifacts from the production process
    • Different types of materials
      • User stories
      • Functional specifications
      • Technical specifications
      • Issue tracker logs
    • Aggregate, index, search, map and re-use
  • Drupal modules you could use
    • Aggregate/Import
      • Feeds (RSS, CSV, HTML, TXT, OPML, XML)
      • Table Wizard and Migrate (SQL, CSV)
      • CMIS API (Sharepoint, Alfresco)
    • Search
      • Apache Solr, Faceted search
    • Tag
      • Taxonomy
  • New modules for the Upstream process
    • Poorman's DITA
      • Use a Drupal form to create basic DITA topics
      • Currently implemented for tasks and concepts
    • Search and insert
      • Search aggregated content and insert it in the forms
  • Developers Managers Product owners Documentation professionals Sales Support Managers End-users DOC-TEAM
  • Pre-formatted starting material for the professionals
    • Modular process: no need to switch DITA editor software
    • No extra licenses needed to involve all stakeholders (upstream and downstream)
    • Better integration of different information silos
    • Less field knowledge required from the documentation professionals
    • Better and more feedback from end-users
  • Developers Managers Product owners Documentation professionals Sales Support Managers End-users DOWNSTREAM
  • Modular: import DITA documentation
    • Upload individual files
    • Import folders
      • Automatic checkout from a version controlled documentation repository
      • Drupal checks for updates
    • Other import options can be tailored for specific use cases to plugin to existing processes
  • Community feedback and subscriptions
    • Feedback mechanisms
      • Tagging (taxonomy)
      • Flagging/bookmarking (flag)
      • Rating (voting API, Fivestar)
      • Comments & change suggestions
    • Update subscription options:
      • Subscribe (Messaging and Notifications framework)
      • RSS (views)
  • User driven assembly and export
    • Bookmark relevant documentation topics
    • Create a new DITA map in the GUI
    • Export the map and the topics it contains
  • Assembly toolbox
    • Build DITA map using Graphmind mindmap UI
      • Drag and drop
    • Build and execute queries from Views
      • Build custom queries from a GUI (Views)
      • Execute queries in Graphmind
    • Export
      • To pdf, xhtml, online help with the DITA Open Toolkit
      • Export DITA topics and map
  • Kristof Van Tomme P RONOVIX [email_address]