Confluence as platform for technical documentation

  • Published on
    08-May-2015

  • View
    3.941

  • Download
    0

DESCRIPTION

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.

Transcript

<ul><li>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.comAtlassian webinar, 12 April 2012Confluence as a Platform for Technical Documentation, by Sarah Maddox1</li></ul> <p>2. Overview of Sarahs presentation Confluence as extensible platform Developing a book on a wiki A platform for technical communicators Add-ons for enhanced functionality Driving wiki developmentConfluence as a Platform for Technical Documentation, by Sarah Maddox 2 3. Wiki as extensible platformConfluence as a Platform for Technical Documentation, by Sarah Maddox 3 4. Wiki as extensible platformExtensibleVersatileEcosystemConfluence as a Platform for Technical Documentation, by Sarah Maddox 4 5. Wiki as extensible platformExtensibleAtlassian: Core ConfluenceVersatile Community developers: Add-onsEcosystemExperts: Integrations and servicesConfluence as a Platform for Technical Documentation, by Sarah Maddox 5 6. Wiki as extensible platformExtensibleAtlassian: Core ConfluenceVersatile Community developers: Add-onsEcosystemExperts: Integrations and servicesCustomersConfluence as a Platform for Technical Documentation, by Sarah Maddox 6 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. Producing a book on a wikiConfluence as a Platform for Technical Documentation, by Sarah Maddox 8 9. Developing the book on the wiki Dogfood Location DiagramsCollaborationConfluence as a Platform for Technical Documentation, by Sarah Maddox 9 10. Developing the book on the wiki DogfoodAuthor LocationReviewers Diagrams Copy EditorCollaboration ArtistConfluence as a Platform for Technical Documentation, by Sarah Maddox9 11. Gliffy for diagrams www.gliffy.comImage copyright Sarah Maddox 2012 Confluence as a Platform for Technical Documentation, by Sarah Maddox10 12. Cool, so now the book is on the wikiConfluence as a Platform for Technical Documentation, by Sarah Maddox 11 13. How to get from the wiki to production ? Confluence as a Platform for Technical Documentation, by Sarah Maddox 12 14. Scroll Wiki DocBook Exporterwww.k15t.comConfluence as a Platform for Technical Documentation, by Sarah Maddox13 15. Technical communicatorsKeep up with new Work in diverse Collaborate technology andenvironmentsmethodologyShare IdeasInnovate Confluence as a Platform for Technical Documentation, by Sarah Maddox 14 16. Technical communicators SkilledPassionate ExperiencedFull of ideasConfluence as a Platform for Technical Documentation, by Sarah Maddox15 17. Technical communicatorsNeed a tool thatcan keep up with usConfluence as a Platform for Technical Documentation, by Sarah Maddox 16 18. Workflow using core ConfluenceImage copyright Sarah Maddox 2012 Confluence as a Platform for Technical Documentation, by Sarah Maddox 17 19. Add-ons for enhanced workflow Configurable workflows Shared workflowswww.comalatech.com Content publishing Live forms www.frevvo.com Conditional routing Digital signaturesAnd more Confluence as a Platform for Technical Documentation, by Sarah Maddox 18 20. Look and feel with core ConfluenceConfluence as a Platform for Technical Documentation, by Sarah Maddox 19 21. Look and feel with core Confluence Themes LogosCSS Velocity layoutsColor Schemes Site home pageConfluence as a Platform for Technical Documentation, by Sarah Maddox20 22. Look and feel with theme plugins Zen Foundation RefinedWiki Builder TechTime Blog BlackBerry iPhone and iPod Touch And moreplugins.atlassian.comConfluence as a Platform for Technical Documentation, by Sarah Maddox 21 23. Zen Foundation themeConfluence as a Platform for Technical Documentation, by Sarah Maddox 22 24. Single source publishingNo wiki is an islandConfluence as a Platform for Technical Documentation, by Sarah Maddox23 25. Importing content into ConfluenceImport FormatToolAnother 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 wikisThe 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. Importing content into ConfluenceImport Format ToolAdobe FrameMakerWebWorks ePublisher converts FrameMaker documents toConfluenceDITA XMLDITA2wiki is a standalone tool that converts DITA XML documents toConfluence format and uploads them into the wiki via a set of Antcommands.WebWorks ePublisher offers a set of standalone tools for conversionand import from DITA XML to Confluence wiki.DocBook XML The DocBook import plugin is a Confluence plugin that convertsDocBook XML to wiki format and imports the pages into aConfluence space. Confluence as a Platform for Technical Documentation, by Sarah Maddox25 27. Exporting content from ConfluenceExport FormatToolAnother 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.PrintThe browsers print option will print a Confluence page. Export to PDF for sophisticated printing options.PDFConfluences 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 Maddox26 28. Exporting content from ConfluenceExport Format ToolDocBook XML Scroll Wiki DocBook Exporter is a Confluence plugin that converts aselected page or pages to DocBook XML.HTMLConfluences built-in HTML export converts a single page, a selection ofpages, or an entire space to HTML.The Scroll Wiki HTML Exporter is a Confluence plugin that exportscontent from Confluence pages to styled HTML files.Eclipse HelpThe Scroll Wiki EclipseHelp Exporter is a Confluence plugin that exportscontent from Confluence to Eclipse Help format.JavaHelpThe Scroll Wiki JavaHelp Exporter is a Confluence plugin that exportscontent from Confluence to JavaHelp format.EPUBThe Scroll Wiki EPUB Exporter is a Confluence plugin that exportsConfluence pages to EPUB format. Confluence as a Platform for Technical Documentation, by Sarah Maddox 27 29. Many, many more add-ons Content reuse Metadata Templates Diagrams and mockups Social media integration Website and application integration You name itplugins.atlassian.comConfluence as a Platform for Technical Documentation, by Sarah Maddox 228 30. Confluence CLI by Bob Swifthttps://plugins.atlassian.com/plugins/org.swift.confluence.cliConfluence as a Platform for Technical Documentation, by Sarah Maddox 29 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. 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 developmentwikitechcomm.onconfluence.comConfluence as a Platform for Technical Documentation, by Sarah Maddox 31 33. Wiki as extensible platformExtensibleAtlassian: Core ConfluenceVersatile Community developers: Add-onsEcosystemExperts: Integrations and servicesCustomersConfluence as a Platform for Technical Documentation, by Sarah Maddox 6 34. Driving wiki developmentExtensibleAtlassian: Core ConfluenceVersatile Community developers: Add-onsEcosystemExperts: Integrations and servicesConfluence as a Platform for Technical Documentation, by Sarah Maddox 33 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.comConfluence as a Platform for Technical Documentation, by Sarah Maddox 34 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. Getting hold of the bookWiki:https://wikitechcomm.onconfluence.comAmazon.com:http://www.amazon.com/Confluence-Tech-Chocolate-Sarah-Maddox/dp/1937434001Barnes &amp; 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 </p>

Recommended

View more >