1: Create Your On-boarding Document
To help you get started, we've shipped a pre-filled document template with the app for the purpose of on-boarding. The document itself also contains the documentation you find here, so you can read and follow the on-boarding guide directly in Confluence. To create your on-boarding document, follow these steps:
- Navigate to the Documents app in your space by clicking the Documents sidebar item. You can find it sitting alongside Pages and Blogs.
- Click New document to launch the Create Wizard.
- Select On-boarding document from the list of options, and click Next.
- You may choose to give the document a new title or leave the defaults as is, and then click Create.
Once your document is created and will appear in the Documents Overview. This Overview is the home for all documents created within your space. It enables you to access, organize, classify, and filter documents from one place in Confluence.
Selecting a document in the overview will expand the Document Details View where you see some metadata about the document, including the title and summary, contributors, version information, and status.
2: Open the document in the Document Viewer
The Document Viewer is a dedicated, scrollable view of all of the pages of your document. In addition to optimizing readability, you can also view and navigate your document using the outline, jump directly into the Confluence editor to edit content, set the document status, and save and manage versions. To open the document in the Document viewer follow these steps:
- In the Details view, click Open in viewer
- Alternatively, double click on the document card
3: Edit the document
In order to modify or add content to your document follow these steps:
- Scroll down to the section in the document that reads Edit the document . Alternatively, click Edit the document in the Document Outline in the left navigation panel.
- Now, click the Edit button as highlighted in the screenshot:
This will open up the Confluence editor. Make some changes to the content, and click Update.
You will be redirected to the corresponding Confluence page.
In order to go back to the Document viewer, click on the document icon on top of the page and the click Open in viewer.
4: Save a 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 use the versioning feature to version multiple pages as a single unit – for example, to track changes to documents throughout the document lifecycle.
- To save a version of this document, click the actions menu ••• in the viewer and select Save a version:
- Assign the version a name, optionally add a comment, then click Save.
- The new version will appear in your Version History below the current working version of the document. Each saved version contains a date and time stamp along with the name of the user who saved the version:
- Now that this version is saved, you can compare this version to the current working version or any future version of the document by clicking through the version cards in the version history.
5: Set a Document Status
With Scroll Documents, you can assign a status to your document to indicate what state it is in. By default, all documents are set to In Progress, but you can choose to set this to Under Review or Approved. Note that these statuses apply to the document itself and not its individual pages.
To change the status of this document, first make sure that you have selected the current version of the document. To do this,
- Go to the actions menu • • • in the Document viewer and click 'Version history'
- This will open the Version History in the left navigation bar
- Click the 'Current' version card to select the current version of the document
- To change the status of your on-boarding document, click the status indicator in the document header to open the Set Status dialog, as shown in the screenshot:
- Use the status picker to change the status from In Progress to Under Review and click Save:
- The status of the document has been changed and is now also visible in the metadata of the document. Statuses also apply to the saved versions of your document and can be updated at any time
Statuses also apply to the saved versions of your document and can be updated in the same way.
6: Export the Document
You can export your multi-page documents to PDF or Word format and use the powerful customization functionality to fully style the output thanks to an integration with Scroll PDF Exporter and Scroll Word Exporter,
In order to take advantage of the export features in Scroll Documents, you need to have these apps installed. If you don't have them on your system, you can try Scroll PDF Exporter and Scroll Word Exporter for free on the Atlassian Marketplace.
The alternative is to export the pages of your document using Confluence's export functionality.
- To export to PDF or Word, click the actions menu ••• and select the format you'd like to export to:
The Scroll PDF or Word Exporter dialogue will appear where you can select your Template and Export Scope. Since this document already consists of a page and its children, the Export Scope has been pre-defined and cannot be edited:
- Select from one of Scroll PDF or Word Exporter's bundled templates or choose one of your own custom templates and click Export:
- Your formatted PDF will be available in your downloads. For more information about Scroll PDF Exporter, please visit the documentation for this app.
That's it! You now know how to create documents, save versions, set statuses, and export to PDF or Word!