Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

Confluence as platform for technical documentation

6,930 views

Published on

Presentation given in an Atlassian webinar, 12/13 April 2012. It's about Confluence wiki as an extensible platform, and how technical communicators can take advantage of the wiki's extensibility.

Published in: Business, Technology

Confluence as platform for technical documentation

  1. 1. Confluence as a Platform for Technical Documentation Sarah Maddox (Atlassian) Confluence as a platform for technical communication Tobias Anstett (K15t Software) Complete the documentation life cycle Darryl Duke (Stepstone Technologies) Simplify and brand your documentationwikitechcomm.onconfluence.com Atlassian webinar, 12 April 2012 Confluence as a Platform for Technical Documentation, by Sarah Maddox 1
  2. 2. Overview of Sarah’s presentation• Confluence as extensible platform• Developing a book on a wiki• A platform for technical communicators• Add-ons for enhanced functionality• Driving wiki development Confluence as a Platform for Technical Documentation, by Sarah Maddox 2
  3. 3. Wiki as extensible platformConfluence as a Platform for Technical Documentation, by Sarah Maddox 3
  4. 4. Wiki as extensible platformExtensibleVersatileEcosystem Confluence as a Platform for Technical Documentation, by Sarah Maddox 4
  5. 5. Wiki as extensible platformExtensible Atlassian: Core ConfluenceVersatile Community developers: Add-onsEcosystem Experts: Integrations and services Confluence as a Platform for Technical Documentation, by Sarah Maddox 5
  6. 6. Wiki as extensible platformExtensible Atlassian: Core ConfluenceVersatile Community developers: Add-onsEcosystem Experts: Integrations and services Customers Confluence as a Platform for Technical Documentation, by Sarah Maddox 6
  7. 7. Confluence, Tech Comm, Chocolate A wiki as platform extraordinaire for technical communicationWikis and technical documentationAgile environmentsSocial mediaCrowd sourcingDriving wiki developmentAnd more wikitechcomm.onconfluence.com Confluence as a Platform for Technical Documentation, by Sarah Maddox 7
  8. 8. Producing a book on a wikiConfluence as a Platform for Technical Documentation, by Sarah Maddox 8
  9. 9. Developing the book on the wiki Dogfood Location DiagramsCollaboration Confluence as a Platform for Technical Documentation, by Sarah Maddox 9
  10. 10. Developing the book on the wiki Dogfood Author Location Reviewers Diagrams Copy EditorCollaboration Artist Confluence as a Platform for Technical Documentation, by Sarah Maddox 9
  11. 11. Gliffy for diagrams www.gliffy.comImage copyright © Sarah Maddox 2012 Confluence as a Platform for Technical Documentation, by Sarah Maddox 10
  12. 12. Cool, so now the book is on the wikiConfluence as a Platform for Technical Documentation, by Sarah Maddox 11
  13. 13. How to get from the wiki to production ? Confluence as a Platform for Technical Documentation, by Sarah Maddox 12
  14. 14. Scroll Wiki DocBook Exporter www.k15t.comConfluence as a Platform for Technical Documentation, by Sarah Maddox 13
  15. 15. Technical communicatorsKeep up with new Work in diverse Collaborate technology and environments methodology Share Ideas Innovate Confluence as a Platform for Technical Documentation, by Sarah Maddox 14
  16. 16. Technical communicators Skilled Passionate ExperiencedFull of ideas Confluence as a Platform for Technical Documentation, by Sarah Maddox 15
  17. 17. Technical communicators Need a tool that can keep up with usConfluence as a Platform for Technical Documentation, by Sarah Maddox 16
  18. 18. Workflow using core ConfluenceImage copyright © Sarah Maddox 2012 Confluence as a Platform for Technical Documentation, by Sarah Maddox 17
  19. 19. Add-ons for enhanced workflow • Configurable workflows • Shared workflowswww.comalatech.com • Content publishing • Live forms www.frevvo.com • Conditional routing • Digital signatures And more Confluence as a Platform for Technical Documentation, by Sarah Maddox 18
  20. 20. Look and feel with core ConfluenceConfluence as a Platform for Technical Documentation, by Sarah Maddox 19
  21. 21. Look and feel with core Confluence Themes Logos CSS Velocity layoutsColor Schemes Site home page Confluence as a Platform for Technical Documentation, by Sarah Maddox 20
  22. 22. Look and feel with theme plugins• Zen Foundation• RefinedWiki• Builder• TechTime Blog• BlackBerry• iPhone and iPod Touch• And more plugins.atlassian.com Confluence as a Platform for Technical Documentation, by Sarah Maddox 21
  23. 23. Zen Foundation themeConfluence as a Platform for Technical Documentation, by Sarah Maddox 22
  24. 24. Single source publishing No wiki is an islandConfluence as a Platform for Technical Documentation, by Sarah Maddox 23
  25. 25. Importing content into ConfluenceImport Format ToolAnother Confluence The Confluence XML export and import tools are useful forwiki downloading the content of a space, or an entire site, and uploading it into another Confluence site.Other wikis The Universal Wiki Converter is a standalone tool that assists in converting pages to Confluence format from other wiki formats.Microsoft Word Confluences built-in Office Connector imports a Word document and converts it to one or more wiki pages based on the criteria you define. It processes one Word document at a time. WebWorks ePublisher provides a set of standalone tools for converting Word documents to Confluence, based on custom styles and formats. Batch processing and scheduling are available. Confluence as a Platform for Technical Documentation, by Sarah Maddox 24
  26. 26. Importing content into ConfluenceImport Format ToolAdobe FrameMaker WebWorks ePublisher converts FrameMaker documents to ConfluenceDITA XML DITA2wiki is a standalone tool that converts DITA XML documents to Confluence format and uploads them into the wiki via a set of Ant commands. WebWorks ePublisher offers a set of standalone tools for conversion and import from DITA XML to Confluence wiki.DocBook XML The DocBook import plugin is a Confluence plugin that converts DocBook XML to wiki format and imports the pages into a Confluence space. Confluence as a Platform for Technical Documentation, by Sarah Maddox 25
  27. 27. Exporting content from ConfluenceExport Format ToolAnother Confluence The Confluence XML export and import tools are useful for downloading thewiki content of a space or an entire site and uploading it into another Confluence site.Print The browsers print option will print a Confluence page. Export to PDF for sophisticated printing options.PDF Confluences built-in PDF export converts a selected page or pages into a single PDF file and provides customized layout and stylesheets. Scroll Wiki PDF Exporter, a Confluence plugin, offers a PDF export with flexible themes for configuring layout and styles.Microsoft Word Confluences built-in Word export performs a basic conversion of wiki content to HTML and applies some predefined Word CSS stylesheets. It processes just one page at a time. Scroll Office is a Confluence plugin that exports Confluence pages to Word based on custom templates. You can export a single page or a hierarchy of pages. Confluence as a Platform for Technical Documentation, by Sarah Maddox 26
  28. 28. Exporting content from ConfluenceExport Format ToolDocBook XML Scroll Wiki DocBook Exporter is a Confluence plugin that converts a selected page or pages to DocBook XML.HTML Confluences built-in HTML export converts a single page, a selection of pages, or an entire space to HTML. The Scroll Wiki HTML Exporter is a Confluence plugin that exports content from Confluence pages to styled HTML files.Eclipse Help The Scroll Wiki EclipseHelp Exporter is a Confluence plugin that exports content from Confluence to Eclipse Help format.JavaHelp The Scroll Wiki JavaHelp Exporter is a Confluence plugin that exports content from Confluence to JavaHelp format.EPUB The Scroll Wiki EPUB Exporter is a Confluence plugin that exports Confluence pages to EPUB format. Confluence as a Platform for Technical Documentation, by Sarah Maddox 27
  29. 29. Many, many more add-ons• Content reuse• Metadata• Templates• Diagrams and mockups• Social media integration• Website and application integration• You name it plugins.atlassian.com Confluence as a Platform for Technical Documentation, by Sarah Maddox 228
  30. 30. Confluence CLI by Bob Swifthttps://plugins.atlassian.com/plugins/org.swift.confluence.cli Confluence as a Platform for Technical Documentation, by Sarah Maddox 29
  31. 31. Plugins in Atlassian OnDemandhttp://confluence.atlassian.com/display/AOD/Atlassian+OnDemand+Plugin+Policy Team Calendars (commercial) Gliffy (commercial) Content Formatting Macros (free) Table Plugin (free) Confluence as a Platform for Technical Documentation, by Sarah Maddox 30
  32. 32. How the book deals with Plugins• Detailed in the content• Listed at end of every chapter• Introduced in chapters 2 and 4• Extolled in chapter 23: Driving wiki development wikitechcomm.onconfluence.com Confluence as a Platform for Technical Documentation, by Sarah Maddox 31
  33. 33. Wiki as extensible platformExtensible Atlassian: Core ConfluenceVersatile Community developers: Add-onsEcosystem Experts: Integrations and services Customers Confluence as a Platform for Technical Documentation, by Sarah Maddox 6
  34. 34. Driving wiki developmentExtensible Atlassian: Core ConfluenceVersatile Community developers: Add-onsEcosystem Experts: Integrations and services Confluence as a Platform for Technical Documentation, by Sarah Maddox 33
  35. 35. Driving wiki developmentRaise requests:http://jira.atlassian.comJoin a user group:http://www.atlassian.com/company/communityContact Atlassian:http://www.atlassian.com/company/contactContact a plugin developer:http://plugins.atlassian.com Confluence as a Platform for Technical Documentation, by Sarah Maddox 34
  36. 36. Developing add-ons yourselfWrite a user macro:http://confluence.atlassian.com/display/DOC/Writing+User+MacrosDevelop a plugin:https://developer.atlassian.com/display/DOCS/Developing+with+the+Atlassian+Plugin+SDKInteract with the APIs:https://developer.atlassian.com/display/CONFDEV/Confluence+Developer+Documentation Confluence as a Platform for Technical Documentation, by Sarah Maddox 35
  37. 37. Getting hold of the bookWiki:https://wikitechcomm.onconfluence.comAmazon.com:http://www.amazon.com/Confluence-Tech-Chocolate-Sarah-Maddox/dp/1937434001Barnes & Noble:http://www.barnesandnoble.com/w/confluence-tech-comm-chocolate-sarah- maddox/1108812996?ean=9781937434007XML Press:http://xmlpress.net/publications/chocolate/ Confluence as a Platform for Technical Documentation, by Sarah Maddox 36

×