Display your metadata as a document header

Owned by Juela Zeneli
Last updated: Oct 01, 2021 by Dea Mandija (Deactivated)
2 min read

Who?

A developer is writing out the release documentation for a new app feature, how exciting!


What? - Use Case

In order for the documentation to be well-structured, it needs a header with all the important information, such as:

  • Feature name;

  • Release version;

  • Release date;

This way, anyone who reads it can automatically get a snapshot of the most important details, before reading further.

To do this, the developer chooses the Content Category “Release Documentation” (that the admin has already created for them.

 

 

After entering all the details, they click on the plus sign to access the Macro Browser, and write “Display Metadata”. The developer can select the Metadata fields they would like to display. They can click on the small “x” sign to remove a field.

 

 

And here’s the final look:

Why? - Added Value & Benefits

Well-structured documentation
Gives a snapshot of the most important information
Suitable visuals

How? - Feature Used

Display Metadata Macro. If you’d like to read more about the feature click here.