Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

With the Metadata for Confluence Cloud, you can build a lot of different use cases, including Process Documentation. You can define content categories Content Categories that allow the creation of pages with pre-defined content and additional Metadatametadata. You can add metadata Metadata fields to the content category Content Category to make sure to fill in the needed information when creating a page from a predefined template. That will help you with having consistently structured information and finding your processes easily by creating different process reports.

...

Find or create a Confluence Space for your process documentation. For each process type, process and sub-process we create a Confluence page — these have properties and relationships that are maintained via metadata. We create process types to categorize processes , and help you find and navigate through them easily. You can also choose to not create the process types and have only processes.

...

In Confluence general administration, Content Categories entry: Let’s create Content Categories with metadata Metadata fields for process type, process, and sub process. The metadata can have different field types:

  • Text gives you the opportunity to let the user fill in the metadata Metadata field with a simple text string.

  • Multi select -> gives the user the option to select several values from several elements pre-defined options coming from a dropdown menu.

  • Single select gives the user the option to select one value from several elements pre-defined options coming from a dropdown menu.

  • With Page link fields you can draw connections, for example, to existing pages.

  • User (single/multi user) allows  → allows you to select all available Atlassian users who have site access.

  • Date allows users to select a date from the past or the future. 

...

Corresponding Content Category

Field name

Field type

Example values

Process

Process Description

Text

-

Norm

Multi select

4 Context of the organization

4.1 Understanding the organization and its context

4.2 Understanding the needs and expectations of interested parties

4.3 Determining the scope of the quality management system

4.4 Quality management system and its processes

5 Leadership 

5.1 Leadership and commitment

5.2 Policy

Process Owner

Single user

-

Process Type

Page link

-

Relevant for Role

Multi select

Product Owner, Software Developer, Software Tester, Marketing Specialist, Sales Specialist

Relevant for Location

Multi select

Tirana, Dresden, London, Vienna

Process Team

Multi user

-

Process Type

Process Type Name

Text

-

Process Type Description

Text

-

Sub process

Sub process Goal

Text

-

Sub process Owner

Single user

-

Relevant for Role

Multi select

Product Owner, Software Developer, Software Tester, Marketing Specialist, Sales Specialist

Process

Page link

-

To use our metadata Metadata fields, they have to be included in Content Categories. For this case, we create a content category Content Category for each process type, process, and sub process.

Now we can add the fields easily. Click on "Add Metadata field" and choose create the fields we've listed in the table above.

...

The screenshots below show you how the templates for process type, process, and sub-process could look like: 

...

  • “Display Metadata” macro: by including it, you can choose to display all the metadata Metadata fields you’ve assigned to the page (process) or select and display only the metadata Metadata fields you need from the page;

  •  “Metadata Report” macro - it displays a table of pages belonging to a the selected Content Category with the assigned Metadata values. The pages to be shown can be configured with filters, based on their Metadata field values. For example, you can use it also to list all sub processes of the current process. The corresponding filter for that we'll add after creating a process page;

  • “Create from template” macro allows us to create a button, which will create a new process type from the template.

...

While creating a process type, the user is now able to display an overview of all processes of this process type. Click on “Edit” Button button of the Metadata Report macro, add a filter for a the process type field and select the one you're creating (you need to publish the page first). 

...

5. Create a new Process 

On In the picture below, first, you can see the Metadata Display Metadata macro, which shows you all metadata the Metadata fields you 've entered earlier, and below is the Metadata Report macro.

...

Now as you have a page for your process, and you can also create sub processes subprocesses for your process. 

...

If you add the following filter to your Metadata Report macro on the process page:

...

… you will see the overview of the sub processes subprocesses of your current process.

...

Well done! You have set up interactive process documentation with a clear structure.