Transcript

How Atlassian Does Docswith Scroll Add-ons by

NILS BIER • CUSTOMER ADVOCATE • K15T SOFTWARE • @K15TSOFTWARE • @NILSINGER

Atlassian

2006

2009

2010

2013

2016

2003 2011

20142002 2004

2005 2007

2012

2015

2008

Major releases - no minor or bug fix releases displayed

Atlassian - Big Data

13Years of making kickass software

6Offices in 5 different countries

12Products in the arsenal

1400+Employees and growing daily

51,000Customers using the products

107User Groups discussing products over pizza and beer

… and much more

11Tech Writers explaining the products

https://www.atlassian.com/company

Atlassian Documentation

confluence.atlassian.com

Design Align

Modernising and harmonising design across all products.

Atlassian Design Guidelines

design.atlassian.com

Products

Products

Aligning design language acrossmarketing, documentation and products

Website

Atlassian Documentation

confluence.atlassian.com

Atlassian Documentation

confluence.atlassian.com

Atlassian Documentation

Atlassian Documentation

Atlassian Documentation

Atlassian Documentation

Atlassian Documentation

Atlassian Documentation

Way back when…

Way back when…

Atlassian Documentation

Atlassian Does Docs in Confluence

Atlassian Documentation written in Confluence

https://confluence.atlassian.com/dashboard.action

External vs. Internal View

External vs. Internal View

Atlassian Uses Scroll Viewport

Scroll Viewport - A theming add-on on steroids

• Disconnect the authoring from the design• Have multiple Viewports per space• URL and permission control over which view is used to display the content • Style with HTML, CSS or JavaScript• Use Confluence as a help center• Display your content beautifully and even responsively styled

What about the picker?

Atlassian Uses Scroll Versions

What is Scroll Versions about?

• Version management• Manage multiple versions in a single space

• Work in parallel with the software development process

• Keep pace with the development team

• Use Confluence as a documentation platform• One system fits all, Confluence as the only platform

• Publish content with a few clicks• Have pages with the same page title within a single space• Manage different product variants on the space level

• They needed a solution that can handle the complexity of the documentation• The tech writers need to be able to work parallel with the development process• Better reuse of content between Cloud and Server documentation sets• Provide a better experience to readers

Why is Atlassian using it?

Spaces

Confluence Cloud

Confluence 5.9 (Latest)

Confluence 5.9

• Each Atlassian product typically has• a single space for Cloud documentation• multiple spaces for Server documentation

• one for the latest version• a single one for each earlier version

Spaces

SpacesConfluence

Cloud confcloud

Confluence Latest doc

Confluence Archive conf59

SpacesConfluence

Cloud confcloud

Confluence Latest doc

Confluence Archive conf59

Spaces

Confluence Master

Confluence Masterdocm

publishes Versions to

Version concept

• A Version is a collection of page edits that can be published at the same time• Versions can reflect the actual versions of your product release cycle• Every version inherits the edits made in previous, dependent versions

• no manual content copy needed, only make actual changes

Confluence Product Timeline (Example)

5.9-OD-15.9 BTF 5.9-OD-2 5.10 BTF

• In Scroll Versions a Doc-Administrator creates a version called 5.9 BTF

• The tech writers can select this version and make page edits associated with that version

Author 5.9 BTF 5.9BTF

5.9OD-1

5.9OD-2

5.10BTF

Confluence Latest doc

Confluence Archive conf59

publishes Versions to

5.9BTF

5.9OD-1

5.9OD-2

5.10BTFRelease 5.9 BTF

Version 5.3

• Now the Doc-Admin creates a 5.9 OD-1 version

• Edit pages for this version

Author 5.9 OD-1 5.9BTF

5.9OD-1

5.9OD-2

5.10BTF

Version 5.3

Release 5.9 OD-1 5.9BTF

5.9OD-1

5.9OD-2

5.10BTF

Confluence Cloud

confcloud

publishes Versions to

Demo time

Version 5.3

Recap

• Versions are built as they are organized in the product development

• Versions are organized in the order that things will ship to customers

• Later versions inherit changes made in earlier versions

Version 5.3

But what if …

• Feature branches are supported• Decide what to name the versions, and how they depend on each other

• Merged as soon as they get included in a major release

Next Iteration …

5.10-OD-45.10-OD-35.9-OD-15.9 BTF 5.9-OD-2 5.10 BTF

How Atlassian Does Docs

Using Scroll Versions:

Technical writers collaborate with developers etc. on docs.

Using Scroll Viewport:Use Atlassian Design for unified visual experience for customers

In Confluence:

Author in different Versions and Variants

Active Installations

powered by Scroll Add-ons

5000+

Thank you!

NILS BIER • CUSTOMER ADVOCATE • K15T SOFTWARE • @K15TSOFTWARE • @NILSINGER

[email protected]

NILS BIER • CUSTOMER ADVOCATE • K15T SOFTWARE • @K15TSOFTWARE • @NILSINGER