Scroll Documents is an app that enables your team to manage your pages as documents – save versions, track changes, manage approvals, and leverage powerful document management functionality in Confluence.Key features include:
Updating a current version — Collaborate on the current version of your document without impacting shared versions.
Version comparison — Visually track changes between the different versions of a document using the Comparison Tool.
Exporting versions — Export a version of your document as a professionally-styled Word or PDF file using an integration with the Scroll PDF Exporter and Scroll Word Exporter apps.
Scroll Documents is an ideal solution for creating versioned content, like product documentation, on Confluence Cloud. If you are interested in versioning content in Confluence Server or Confluence Datacenter, learn more about Scroll Versions.
Get Started with Documents
This is a step-by-step tutorial to help you get started with Scroll Documents. In this tutorial, you'll learn how to:
Create a new document
Add content to the document
Browse all Documents in the space
Use the Document Reader to read and share the document
Save a document version
Export the document to PDF or Word
If you've already created your first document, you can skip to Step-3: Use the Document Reader to read and share the document.
1: Create a new document
To start, you’re going to create a new document and add it to your space.
Click Scroll Documents in the space sidebar to navigate to the Document Library in your space.
Click New Document. The Create new document dialog displays.
Create new document
Because we’re creating a document with all new pages and content, you can select Create a new page tree.
Step 1: Name your Document
Name your document and select where it will reside in your space.
- Enter a document title of your choice, in this example you can name it "Smart App Documentation".
- Click Next.
Step 2: Add metadata
Add useful information to your document to help people find it and understand what it’s about.
- In Labels, enter “documentation”.
You can use this later to find and categorize the document.
- In Summary, enter “This is the product documentation for Smart App”.
This will help you and other users know what this document is about without having to open or read each individual page.
- In Cover image, add an image of your choice.
This helps you visually identify and distinguish your document in the document library.
- In Status, select “In Progress”.
This conveys the state of the document to readers and the contributors.
- In Labels, enter “documentation”.
2. Click Next.
Step 3: Add pages
- Add existing pages, or add add some new ones, to your document to build the page tree.
✅ Read more about how to structure and reorder the pages
- Click Save.
The tree of pages you just created as a document and is added to the space sidebar.
2: Add content to the document
Now that you’ve created your first document, you can update the contained pages the same way you would update any other page.
Click Edit in the top right of any page within your document to add or change some content.
When you’ve finished make updates to a page, click Update to close the editor.
All changes are reflected in your document.
3: Browse all documents in the space
Your created documents appears in the Document Library.
The Document Library is the home for all documents created within your space. It enables you to access, organize, classify, and filter documents from one place.
For each document, you can see the title and the avatar of the user who created the document, along with the creation date.
Click Scroll Documents in the space sidebar.
4: Use the Document Reader to read and share the document
The Document Reader is a dedicated, scrollable view of all of the pages of your document. The reader is an ideal way to share your document with your readers.
In the reader, you can -
- Read any version of the document using the version picker.
- Navigate through the interactive outline to jump to section you are interested in reading.
- Switch between a narrow view and a wide view on the content.
- Share the version of the document you are reading
- Export the document to PDF and Word files
Quickly jump into the underlying Confluence pages to start editing them.
5: Save a document version
When you save a version of a document, you're saving a snapshot of that document's page structure and content at a certain point in time. You can version multiple pages as a single unit – for example, to track changes to documents throughout the document lifecycle.
You’ll create a new version in the Document Manager. The Document Manager is the central hub for all your document management needs.
From the Document Library, click the cog icon in the bottom-right corner of the document card. You are now in the Document Manager.
Click Save a version. The New version dialog displays.
Optionally add the following:
In Version, enter “1.0”
In Description, enter “Updated the document.”
In Status, select “Approved”.
The new version appears in the version history table along with the original version ('Working version'). The versions are automatically sorted according to the version name.
Each saved version displays a date, time stamp, and the name of the user who saved the version.
Now this version is saved, you can compare this version to the current working version or any future version of the document by clicking Compare versions.
6: Export the document to PDF or Word
You can export any version of your document as a PDF or Word file with complete control over styling using the Scroll Documents integration with the Scroll PDF Exporter and Scroll Word Exporter apps.
To export a document version using Scroll PDF Exporter or Scroll Word Exporter:
From the Document Library, click cog icon on the document card. You are now in the Document Manager.
- Click on the Export button to see the available export options. Choose the one applicable to you.
Select one of the included templates or select one of your own custom templates.
That's it! You now know how to create a document, save a document version, set a status, and export a document as a PDF or Word file.