Download pptx - Confluence as platform for technical documentation

Confluence as a Platform for Technical Documentation

Sarah Maddox (Atlassian)

Tobias Anstett (K15t Software)

Darryl Duke (Stepstone Technologies)

Simplify and brand your documentation

Complete the documentation life cycle

Confluence as a platform for technical communication

Confluence as a Platform for Technical Documentation, by Sarah Maddox 1

wikitechcomm.onconfluence.com

Atlassian webinar, 12 April 2012

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


Wiki as extensible platform




Extensible

Versatile

Ecosystem



Extensible

Versatile

Ecosystem

Atlassian: Core Confluence

Community developers: Add-ons

Experts: Integrations and services



Extensible

Versatile

Ecosystem




Customers

Confluence, Tech Comm, Chocolate

A wiki as platform extraordinaire for technical communication

Wikis and technical documentation

Agile environments

Social media

Crowd sourcing

Driving wiki development

And more



Producing a book on a wiki


Developing the book on the wiki

Dogfood

Collaboration

Diagrams

Location


Dogfood

Collaboration

Diagrams

Location

Artist

Copy Editor

Reviewers

Author


Developing the book on the wiki

Gliffy for diagrams

www.gliffy.com

Image copyright © Sarah Maddox 2012


Cool, so now the book is on the wiki


How to get from the wiki to production

?Confluence as a Platform for Technical Documentation, by Sarah Maddox 12

Scroll Wiki DocBook Exporter

www.k15t.com


Technical communicators

Keep up with new technology and methodology

Innovate

Share Ideas

CollaborateWork in diverseenvironments



Full of ideas

Experienced

PassionateSkilled



Need a tool thatcan keep up with us


Workflow using core Confluence

Image copyright © Sarah Maddox 2012


Add-ons for enhanced workflow

www.comalatech.com

www.frevvo.com

• Configurable workflows

• Shared workflows

• Content publishing

• Live forms

• Conditional routing

• Digital signatures

And more


Look and feel with core Confluence


Look and feel with core Confluence

Themes

CSS

Color Schemes

Logos

Velocity layouts

Site home page


Look and feel with theme plugins

• Zen Foundation

• RefinedWiki

• Builder

• TechTime Blog

• BlackBerry

• iPhone and iPod Touch

• And more plugins.atlassian.com


Zen Foundation theme


Single source publishing

No wiki is an island


Import Format ToolAnother Confluence wiki

The Confluence XML export and import tools are useful for 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 Confluence's 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.


Importing content into Confluence

Import Format Tool

Adobe FrameMaker WebWorks ePublisher converts FrameMaker documents to Confluence

DITA 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.

Importing content into Confluence


Export Format ToolAnother Confluence wiki

The Confluence XML export and import tools are useful for downloading the content of a space or an entire site and uploading it into another Confluence site.

Print The browser's print option will print a Confluence page. Export to PDF for sophisticated printing options.

PDF Confluence's 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 Confluence's 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.

Exporting content from Confluence


Exporting content from Confluence

Export Format ToolDocBook XML Scroll Wiki DocBook Exporter is a Confluence plugin that converts a

selected page or pages to DocBook XML.

HTML Confluence's 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.


Many, many more add-ons

• Content reuse

• Metadata

• Templates

• Diagrams and mockups

• Social media integration

• Website and application integration

• You name itplugins.atlassian.com


Confluence CLI by Bob Swift

https://plugins.atlassian.com/plugins/org.swift.confluence.cli


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)


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





Extensible

Versatile

Ecosystem




Customers



Extensible

Versatile

Ecosystem





Raise requests: http://jira.atlassian.com

Join a user group: http://www.atlassian.com/company/community

Contact Atlassian: http://www.atlassian.com/company/contact

Contact a plugin developer: http://plugins.atlassian.com


http://jira.atlassian.com/

http://jira.atlassian.com/

http://www.atlassian.com/company/community

http://www.atlassian.com/company/contact/

http://www.atlassian.com/company/contact/

http://plugins.atlassian.com/

http://plugins.atlassian.com/

Developing add-ons yourself

Write a user macro: http://confluence.atlassian.com/display/DOC/Writing+User+Macros

Develop a plugin: https://developer.atlassian.com/display/DOCS/Developing+with+the+Atlassian+Plugin+SDK

Interact with the APIs: https://developer.atlassian.com/display/CONFDEV/Confluence+Developer+Documentation


http://confluence.atlassian.com/display/DOC/Writing+User+Macros

https://developer.atlassian.com/display/DOCS/Developing+with+the+Atlassian+Plugin+SDK

https://developer.atlassian.com/display/DOCS/Developing+with+the+Atlassian+Plugin+SDK

https://developer.atlassian.com/display/CONFDEV/Confluence+Developer+Documentation

https://developer.atlassian.com/display/CONFDEV/Confluence+Developer+Documentation

Getting hold of the book

Wiki:https://wikitechcomm.onconfluence.com

Amazon.com:http://www.amazon.com/Confluence-Tech-Chocolate-Sarah-Maddox/dp/1937434001

Barnes & Noble:http://www.barnesandnoble.com/w/confluence-tech-comm-chocolate-sarah-maddox/1108812996?ean=9781937434007

XML Press:http://xmlpress.net/publications/chocolate/


https://wikitechcomm.onconfluence.com/

http://www.amazon.com/Confluence-Tech-Chocolate-Sarah-Maddox/dp/1937434001

http://www.amazon.com/Confluence-Tech-Chocolate-Sarah-Maddox/dp/1937434001

http://www.barnesandnoble.com/w/confluence-tech-comm-chocolate-sarah-maddox/1108812996?ean=9781937434007

http://www.barnesandnoble.com/w/confluence-tech-comm-chocolate-sarah-maddox/1108812996?ean=9781937434007

http://xmlpress.net/publications/chocolate/