In this tutorial, you will learn how to add a new page to your documentation, use page templates, re-organize the structure your content, and then save a new version of your documentation.
Scroll Documents for Confluence
Scroll Documents introduces advanced content management features to Confluence, complete with version management and change tracking. Scroll Documents can also be extended to enable you to define and manage variants and translations of your documentation so you can deliver the right content to various audiences.
In this tutorial, we’ll focus on the base functionality of Scroll Documents and help you get started with versioning. Before you begin, please ensure you have Scroll Documents installed in your space.
Prepare your sample documentation
Scroll Documents offers an out-of-the box Product Documentation template that we will use to test the app.
Navigate to the space where your documentation lives or where you’re comfortable testing the app.
ℹ️ Info: We highly recommend creating a new blank space before proceeding.
Don’t have the permission to create a new space? Choose any existing space that you may have access to.
Next, click Scroll Documents under the APPS section in left navigation bar.
Then click New Document → Start from template.
Select Product Documentation → Next.
Leave the default values as is, and click Save.
Once the documentation is created click Working version.
Feel free to click around the different articles to see how topics in your documentation can be created and organized in Confluence.
Open the documentation manager
The documentation manager is the command center for managing your documentation with the Scroll Apps in your Confluence space.
You can access the documentation manager from the Document Library.
ℹ️ Info: The document library lists all the documentation you manage with Scroll in a Confluence space.
Now you are in the Documentation Manager.
Before we save a new version, we’ll first edit the working version of the documentation.
To do so, click on the ‘Working version’ link.
Edit the working version of your documentation
Add a new article to your documentation
You are now in the working version of your documentation. We will start by adding a new How-to article to the documentation.
ℹ️ Info: Think of the working version as the continuously progressing version of your documentation. You will use this version to prepare changes to your documentation and save a version once complete. Think of your versions as snapshots of your working version .
Select an out-of-the-box page template
You are now in the Confluence page editor.
ℹ️ Info: Confluence comes with 100s of templates out-of-the-box. You can even create your own templates.
Add content to the article and publish it
The template comes with a pre-defined structure and some instructional text.
Feel free to edit the content and explore the editor options.
But, for now, you can can simply hit Publish.
The new page is now created and added at the bottom of your documentation page tree.
You will also notice that an additional page titled How-to articles was automatically created. This page is called an index page and is automatically added by Confluence when you create a new page from an out-of-the-box page template.
This page lists all the pages created with the How-to article template in the Confluence space.
Re-organize your documentation structure
You can easily restructure your documentation by dragging and dropping the articles (pages) in the left navigation bar.
🎉 Congratulations! You have successfully updated the working version of your documentation.
➡️ Next you will save a new version of your documentation.
Save a new version of your documentation
To save a new version, navigate back to the Documentation Manager by following the steps described earlier. Then, click on Save a version.
In the dialog, update the following fields:
Then, click Save.
Wait until you see a success message at the bottom-left of the screen saying - Version created.
🎉 Congratulations! You have successfully created the first version of your documentation, and in the process learned how to create and edit new pages, use out-of-the-box templates, and re-organize your documentation structure in Confluence.
Create and manage variants and translations
In addition to saving versions, you’re also able to create variants and translations of your documentation and publish this content to your users. With Scroll Documents alone, these feature sets are limited to 2 variants and 2 languages per document. Should your team need more than this, you can install the extension apps.
Here is where you can access the Variants and Translations features:
From the Documentation Manager of your document, select Manage in the top right-hand corner.
This is where you can access the Variants and Translations functionality.
Variants let you define content that is only shown under specific conditions. This is particularly helpful when you want to control the scope of content that gets published.
Learn more about creating and managing Variants here →
Translations enable you to localize your content and deliver your document in any of the languages it has been translated into.
Learn more about creating and managing Translations here →
Scroll Documents: What’s next?
Saving versions is only the beginning. Scroll Documents offers a host of powerful features that will transform the way you create and manage your documentation. Please visit Scroll Documents' app documentation to get the most of out of the app. For example:
Track and Review Documents: Keep an overview of changes to your documentation over time. View document activity, compare changes, and set and track workflow states.
Deliver and Publish Documents: Find a publishing workflow that works best for your team.
Scroll Apps: Let’s Continue
Version management: Check! Dive deeper into the Scroll Apps to learn how to publish your documentation – along with its versions, variants, and translations – with the rest of the Scroll Apps: