Want to use our Documentation Template? Simply install Mosaic for Confluence and choose it from the Confluence templates library.
Once you've installed Mosaic, follow these steps:
Create a new page or live doc in Confluence, then click All templates from the bottom menu.
Click on the templates search bar and type ‘Mosaic’.
Select the ‘Documentation’ template to get started, or hover over it for a preview.
What is documentation?
You likely have plenty of detailed guides, manuals, and reference materials for your business's customers and employees. Documentation can be highly technical and detailed or a short and simple how-to guide to ensure someone can use a product or service.
If you've struggled to get documentation into a logical and practical format, it might be time to start afresh. Our Confluence Documentation Template has everything you’ll need.
Whatever you sell, you need to offer support. Documentation can include everything from common FAQs to legal information you must provide to ensure a user’s safety, so it’s a real business essential.
Did you know that a massive 83% of employees recreate missing documents? If something can’t be found, it can be lost forever. Accessible documentation can be a huge time-saver!
It’s been suggested that knowledge workers spend an average of 50% of their time creating and preparing documents, but without a document management strategy, 25% of these documents will be lost!
When you store documents in a documentation template with Confluence, you can watch pages or the space to know when changes are made. You'll even get an email notification about who changed what, so you're always a step ahead. And because users can ‘like’ pages, you know they're valid.
Whatever you sell, you need to offer support. Documentation can include everything from common FAQs to legal information you must provide to ensure a user’s safety, so it’s a real business essential.
Did you know that a massive 83% of employees recreate missing documents? If something can’t be found, it can be lost forever. Accessible documentation can be a huge time-saver!
It’s been suggested that knowledge workers spend an average of 50% of their time creating and preparing documents, but without a document management strategy, 25% of these documents will be lost!
When you store documents in a documentation template with Confluence, you can watch pages or the space to know when changes are made. You'll even get an email notification about who changed what, so you're always a step ahead. And because users can ‘like’ pages, you know they're valid.
Whatever you sell, you need to offer support. Documentation can include everything from common FAQs to legal information you must provide to ensure a user’s safety, so it’s a real business essential.
Did you know that a massive 83% of employees recreate missing documents? If something can’t be found, it can be lost forever. Accessible documentation can be a huge time-saver!
It’s been suggested that knowledge workers spend an average of 50% of their time creating and preparing documents, but without a document management strategy, 25% of these documents will be lost!
When you store documents in a documentation template with Confluence, you can watch pages or the space to know when changes are made. You'll even get an email notification about who changed what, so you're always a step ahead. And because users can ‘like’ pages, you know they're valid.
What elements should documentation include?
Please note: The following modules are all found in our Documentation Template, but like all of our templates, it is fully customisable. If you want to change the look, feel, or function, you can at any point.
Technical information
For software documentation, it’s important to include information that helps users understand what and how the software works. System requirements are useful to make users aware of any compatibility issues (as well as how to achieve optimal performance), and installation steps help users set up the software. Splitting key steps into tabs helps improve clarity so that users can follow the instructions with ease.
Troubleshooting and Use Cases
Want to reduce support time? Providing a list of common issues that your customer/IT teams frequently encounter can help cut down on repeated tickets and get questions answered faster.
To give users a clearer picture of how your product or service can be used, it’s also helpful to include use cases that demonstrate it in action in real life. If you’ve got a lot of use cases to share, organise them into collapsible sections or link to different pages using the Advanced Cards macro.
Visual cues to improve readability
Documentation can be vast, so try make it easy on the eye. Macros like an Interactive Banner can be useful for sharing product/service announcements and features in a compact way, whereas buttons can make links more interactive. You can also add a table of contents to the top of the page to help users find the right section in seconds.
Making life easier for thousands of users
Don't just take our word for it. See why our engaging Confluence templates have been published over 2000 times this year.
A company hub lets users easily access company news and information. Our Company Hub Templates have everything you need to produce the perfect central resource.