9 Confluence Best Practices Your Users Should Know

June 4, 2024
#Confluence Tutorial#Confluence#Document management#How To
10 min

This guest blog was written by Balkis Khouni, an Atlassian certified consultant at Valiantys. Valiantys is a top Atlassian Platinum Solution Partner with proven expertise in DevOps, Agile and ITSM. They have rendered client-tailored services to over 4,000 companies, providing expert guidance on the deployment, adoption and support of Agile tools. To find out more, visit valiantys.com.

Confluence is a content collaboration software that helps teams create, share and discuss their work. One of the tool’s characteristics is it’s simple and user friendly interface, yet also provides all the necessary features to organize and structure your company’s content on one single platform.

Because of the tool’s simplicity, it is easy for users to add content without following good practices or guidelines, resulting in an unstructured wiki which can be counterproductive and hard to browse.

It is highly recommended to define a list of guidelines for your users, so they know how they should structure content within Confluence. Below are some general best practices which will help optimize your company’s use of Confluence and make information sharing a breeze for everyone. While these tips are geared more towards day-to-day usages, for further information on how to make Confluence a fully-fledged Enterprise Content Management solution check out this guide from Atlassian.

1. Identify the list of spaces you need to create

Spaces are like folders, which allow you to organize your content by different categories.

We recommend creating a space per Team (i.e. Finance) or by Project (i.e. Software development).

2. Take the time to define your page structure

In each space, it is important to set up a clear and organized page structure so content is grouped by subject and relevance. You can use page hierarchy to group several pages under one single parent page. For example:

Page tree in Confluence

When you have several levels of hierarchy, it might be useful to use the Children Display macro on parent pages. This way, users won’t have to expand the whole tree to find their page.

3. Use page templates

Confluence comes with a set of page templates, also called Blueprints, that allow you to:

  • Group pages by category of content (i.e. How To articles, Meeting Notes, etc.).
  • Have a standard layout and structure for those pages.
  • Save your employees’ time, as they aren’t recreating the wheel with each page.

Confluence gives you the flexibility to set up your own templates and promote them to users, so they’ll have easy access to the pages. We recommend using the Create from Template macro, on your home page space, and also train users on the details for each available template.


Quick Tip 

You can also structure your content as training materials for onboarding or internal education.

Click here to learn how!


4. Increase productivity by using Confluence macros

Confluence comes with a set of useful macros that provide a range of functionalities, which can make your pages more dynamic and customizable. This can enhance the look and feel of your pages while improving the user experience when browsing through content. A full list of macros bundled in Confluence can be found here. Alternatively, the Atlassian Marketplace offers a range of apps which can give you more choices for third party macros.

Confluence macros

5. Organize your attachments

Confluence makes it easy to attach files to your pages, however keep in mind the following best practices:

  • Make sure to name your attachments in a way that is meaningful to make it easy for users to browse through them.
  • When uploading and updating version of an attachment, make sure to not rename it. By using the same name, the attachment is replaced rather than duplicated.
  • Optionally, you can organize your attachments in folders so all your files can be viewed in a structured manner. This can be achieved by using the Smart Attachments for Confluence app.

6. Avoid redundant content

Redundant content can be hard to avoid, especially if you need the same content in more than one place within your wiki. However, by duplicating content, it makes it difficult to keep everything updated without it becoming a tedious task.

To avoid this scenario, you can use the Excerpt and Excerpt Include macros and embed sections of your pages into other pages.

7. Label your content

Labels are an easy way to group pages and attachments that are relevant to the same topic, making it easier for users to find what they need.

A good rule of thumb is to make sure to choose labels that are relevant and meaningful. When labels are used consistently, you can make use of handy macros such as Content by Label.

8. Grant permissions wisely

It’s true that too many cooks spoil the broth. If you have too many administrators, chances are they’ll configure Confluence for their own needs rather than taking into consideration a global view, and in effect too many configurations in different directions can lead to performance issues. Make sure to give users the exact permissions they need to perform their work, and minimize the number of system and space administrators to no more than five people.

9. Train Confluence users to adopt best practices

Confluence is very easy to use, which can be a double-edged sword – everyone can use Confluence, but over time everyone can also contribute to creating a disorganized wiki if users are not mindful of their actions.

It is crucial to invest in your Confluence users, and train them on why it is important they use the right page structure, add the right labels, use the right macros, etc. To nail down these basics, Valiantys offers a Confluence in Action User Training to get your entire team on the same page. Likewise it is also important Confluence administrators are trained, as they will be supporting users and making changes that affect the whole system. Valiantys’ Advanced Confluence Training gets your admins ready to manage their own instance in just one day.

For more information on training your team to implement best practices on Confluence – or even the rest of the Atlassian suite – refer to Valiantys’ comprehensive trainings.

Case Study: How a FinTech Company Improves Code Review Process

June 30, 2020
#Bitbucket#Case Study
7 min

We’ve got pretty good with our Pull Request and Code Review process, but initially, our PRs were complex, not very well documented, and difficult to read. The Resolution Time Distribution graph shows how better we are getting at this, being able to merge PRs much quicker than before.

Pablo Reyes, VP Engineering at Strands

Strands is one of our customers that has been using Awesome Graphs for Bitbucket for a couple of years so far. Since 2004, Strands has been developing highly customizable digital money management software for top-tier financial institutions worldwide. Our team is happy to help them reach their goals and improve their development processes with the statistics visualizations we provide.

Pablo Reyes, VP of Engineering at Strands, shared best practices on how their team effectively uses our solution to:

  • identify bottlenecks in code review
  • track the process improvement with the implemented changes
  • increase developers’ motivation by keeping an eye on their performance trends.

Code review process improvement

In fact, they’ve got pretty good with their Code Review process so far. But initially, the PRs were complex, poorly documented, and difficult to read. The Resolution Time Distribution report shows how better they are getting at this, merging PRs much quicker than before. code review process improvement in Bitbucket

Since they do a lot of code reviews at Strands, it’s always nice to see who and what teams are making the best use of it. It’s motivating for the team to see the progress, and the Pull Requests reports give them the perfect overview of these advancements.

A couple of years ago, they started improving their code review process. For example, they introduced the practice of approving PRs by at least three people. Moreover, they encouraged developers to leave many comments and suggestions and only approve a PR once it’s good enough.

As a result, PRs are resolved faster, not only because they are done better but also because the quality of suggested improvements rises constantly. The Contributions report gives an overview of code review activity and whether it improves or not.

contributions report in Bitbucket

Software development tracking

At Strands, managers don’t use Awesome Graphs to control the number of commits per developer. Still, they find it useful to look at the dynamics of the overall activity to capture the code development trends. For example, if there’s a significant drop, the developer is probably stuck at difficult tasks or disturbed by various activities, helping other teams or communicating with customers.

Most things are caught soon in the day-to-day communication and work, but mid-term changes in the trend (either a decrease or increase) give them a hint of something they may need to look at. This has been visible when people change projects or teams.

The developer’s Contributions graph gives a clear view of this kind of drops and rises, and it’s handy to compare two periods before and after certain changes were implemented.

developer contributions in Bitbucket

Any emerging trend serves as a valuable point for discussion, enabling the team to identify potential bottlenecks or areas that can be enhanced within their software development process. Developers’ performance is complex and depends on lots of different things, some quantitative and some qualitative. Still, the aggregation of code contributions (comments, pull requests, tasks solved, commits, etc) gives some good indicators of how a team evolves with time.

Along with the others, the Contributors graph provides insights into the dynamics of code contributions by different teams and helps with software development tracking.

software development tracking

Try the best teams’ practices for your company

Awesome Graphs for Bitbucket has become a helpful tool for Strands to identify problem areas  in their processes and track whether the implemented changes improve them. Besides, it is a handy instrument for regular monitoring of software development.

Try Awesome Graphs for Bitbucket for free and discover how it can benefit your workflow.

Read more case studies to see how our customers benefit from using Awesome Graphs for Bitbucket in their work:

Related posts

    How to Easily Adjust Templates in Atlassian Confluence

    August 15, 2019
    #How To#Confluence#Case Study
    9 min

    In its 15 years of existence, Confluence has become one of the leading solutions for building knowledge bases and creating documentation together with your team. However, a lot of companies are still getting used to the new software after migration and a lot of organizations that use Atlassian products still hire new employees without Confluence experience.

    Naturally, novice Confluence users have lots of questions about the new software:

    • How to create required documents and format their content?
    • How to protect sensitive data and share public information?
    • How to organize meetings and discuss projects?

    You can use various Confluence features to achieve your goals and automate everyday routine tasks. But sometimes it is not obvious for novice Confluence users what tools to choose for this or that case. So, they reach out to more experienced colleagues or may post questions on the Atlassian Community. For example, we’ve recently found a lot of questions about Confluence templates there.

    Atlassian community questions

    A template is one of the most useful Confluence features that can significantly ease your working life. After reading this blog post, you will be able to use templates freely.

    Use case: creating and managing release notes

    Imagine that you work in a software company that uses Confluence on a regular basis. Your department has a real disaster with its release notes pages. Everybody creates them chaotically at different levels of the space page tree. Besides, your colleagues use their own page structures and decide what information to add themselves. Every page looks differently. The users also give various page titles and forget to add labels. So, it is rather difficult to find the required data.

    Let’s use Confluence templates and deal with this mess together.

    What is a template?

    A template is a Confluence page with predefined content. There are two kinds of templates:

    • Global templates that are available in every space of your corporate Confluence site. These templates are defined by your Confluence administrator.
    • Space templates that are used in a specific space. Space templates are defined by space administrators.

    Why do you need templates?

    You can create new pages based on templates and save your time on content formatting. Just click the “Create from template” button and choose the required item. Let it be the standard “Meeting notes” template.

    Jira templates

    Now you can follow the instructional text and fill out the required fields of your document. Note that all instructional text disappears as you type in your own information. You also can’t see instructional text while viewing a page.

    Meeting notes template

    When you create a page from a standard built-in Confluence template for the first time in a space, a new shortcut and an index page will be created. Space shortcuts allow you to access your pages quickly and easily. The index page displays a list of pages based on this template and certain summarized information about them.

    meeting notes in Confluence

    Here is an example of the “Meeting notes” index page:

    Meeting notes index page

    Where can you find templates?

    If you have the Space admin permission, go to the Space tools menu and find the Content tools → Templates. Here you can see all the space templates: built-in and customized (created by the space administrators).

    Confluence space templates

    What can you do with templates?

    You can easily adjust Confluence templates for your needs:

    • Promote a template if you want your colleagues to pay attention to it and begin to use it constantly. All other templates will be hidden under the Show more linkIf someone uses the Show more link more than three times in a single space, the dialog will show you all the templates by default from then on.

    Promoted template in Confluence

    • Edit an existing template to customize it: add and delete macros, variables, tables, labels, images, and instructional text. Work with your template like with any other Confluence page. The only difference is that you can’t upload images or attachments directly to your template, but you can find them on other pages. Having a special page as a resource library for these types of things is recommended.
    • Create new templates if you have any specific corporate documents that you want to use in Confluence.
    • Delete/disable a template if you don’t want it to be available in this space.

    Note that you can use page templates only when you add a page. It is not possible to apply a template to an existing page.

    Let’s resolve your case

    Now that we are done with the theory, let’s return to your task.

    Step 1. Design your own template

    As there are no any built-in “Release notes” Confluence templates, you need to create your own new template. Feel free to use instructional text and don’t forget to add labels if you want to assign them automatically.

    To add instructional text go to the Template menu of your toolbar and choose the corresponding item.

    Create release notes template in Confluence

    Step 2. Share your template with the team

    Now you need to show your colleagues that the “Release notes” template exists. You can just promote it.

    Promoted release notes template

    Step 3. Get your page tree organized

    Now you need to organize all your future release notes pages within the space. Create a new parent page for them and add the “Create from template” macro to it. Edit the macro body as it’s shown in the slide below: choose your new template and customize page titles. Now your colleagues can easily create release notes pages directly from this parent page. 

    Create from template macro

    Check the results

    From now on the release notes pages will have the same structure, titles, labels, and parent page. Your space will be organized neatly, and it will be much easier to find relevant content.

    Confluence templates

    How to quickly learn all Confluence features?

    If you want to know more about real-life challenges in Confluence, take our free Quick Start with Confluence training course.

    Our motto is “one use case, one module”. You’ll learn everything you need for the case in the corresponding lesson and boost your productivity immediately.