K15t - How Atlassian Does Docs
5 likes1,198 views
Atlassian utilizes Scroll add-ons to enhance its documentation process, employing Scroll Viewport for theming and Scroll Versions for version management, enabling tech writers to synchronize their work with development teams. This system allows for the creation of multiple versions and effective content management while providing a responsive experience for users. Ultimately, Atlassian's approach streamlines documentation by keeping all information centralized in Confluence, supporting both cloud and server documentation needs.
K15t - How Atlassian Does Docs
- 1. How Atlassian Does Docs with Scroll Add-ons by NILS BIER • CUSTOMER ADVOCATE • K15T SOFTWARE • @K15TSOFTWARE • @NILSINGER
- 2. Atlassian 2006 2009 2010 2013 2016 2003 2011 20142002 2004 2005 2007 2012 2015 2008 Major releases - no minor or bug fix releases displayed
- 3. Atlassian - Big Data 13 Years of making kickass software 6 Offices in 5 different countries 12 Products in the arsenal 1400+ Employees and growing daily 51,000 Customers using the products 107 User Groups discussing products over pizza and beer … and much more 11 Tech Writers explaining the products https://www.atlassian.com/company
- 5. Design Align
- 6. Modernising and harmonising design across all products.
- 8. Products
- 9. Products
- 10. Aligning design language across marketing, documentation and products
- 11. Website
- 20. Way back when…
- 21. Way back when…
- 23. Atlassian Does Docs in Confluence
- 24. Atlassian Documentation written in Confluence https://confluence.atlassian.com/dashboard.action
- 25. External vs. Internal View
- 26. External vs. Internal View
- 28. 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
- 29. What about the picker?
- 31. 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
- 32. • 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?
- 34. • 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
- 36. Spaces Confluence Cloud confcloud Confluence Latest doc Confluence Archive conf59 Spaces Confluence Master Confluence Master docm publishes Versions to
- 37. 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
- 38. Confluence Product Timeline (Example) 5.9-OD-15.9 BTF 5.9-OD-2 5.10 BTF
- 39. • 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.9 BTF 5.9 OD-1 5.9 OD-2 5.10 BTF
- 41. 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.9 BTF 5.9 OD-1 5.9 OD-2 5.10 BTF
- 42. Version 5.3 Release 5.9 OD-1 5.9 BTF 5.9 OD-1 5.9 OD-2 5.10 BTF Confluence Cloud confcloud publishes Versions to
- 43. Demo time
- 44. 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
- 45. 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
- 46. Next Iteration … 5.10-OD-45.10-OD-35.9-OD-15.9 BTF 5.9-OD-2 5.10 BTF
- 47. 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
- 48. Active Installations powered by Scroll Add-ons 5000+
- 49. Thank you! NILS BIER • CUSTOMER ADVOCATE • K15T SOFTWARE • @K15TSOFTWARE • @NILSINGER
- 50. info@k15t.com NILS BIER • CUSTOMER ADVOCATE • K15T SOFTWARE • @K15TSOFTWARE • @NILSINGER