Skip to content
Documentation

    Templates

    Templates simplify and accelerate the creation of changelogs, release notes, and other announcements, and ensure a consistent experience with every update.

    Basics

    Section titled “Basics”

    Creating a New Template

    Section titled “Creating a New Template”
    1. Navigate to the Templates section of your workspace ⚙ Settings.
    2. Click on Create to create a new template.
    3. Choose an existing template to start with or start from scratch.
    4. Customize the template with placeholders and formatting options as needed.
    5. Save your template with a descriptive name for future use.

    Editing an Existing Template

    Section titled “Editing an Existing Template”
    1. Navigate to the Templates section of your Settings.
    2. Select the template you wish to edit from the list.
    3. Modify the template content and placeholders.
    4. Save your changes to update the template.

    Basic Formatting Support

    Section titled “Basic Formatting Support”

    Aside from the above AI blocks, you can use most of the regular blocks available in the standard editor for templates as well. For more details, see the editor documentation.

    Template Example
    Template Example

    AI Blocks

    Section titled “AI Blocks”

    Our template feature includes dynamic placeholders that can be populated using AI-generated content. These placeholders ensure that your release notes are informative, consistent, and engaging.

    Title

    Section titled “Title”

    Generates a title based on the post content.

    Type / while editing the title field and select Title in the AI blocks section.

    Introduction

    Section titled “Introduction”

    Generates an introduction based on the post content.

    Type / in the content editor and select Introduction in the AI blocks section.

    Issue sections

    Section titled “Issue sections”

    This block generates descriptions for all issues of the specified type(s) in paragraph format.

    For example: If the selected issue type was “Story”, and the filter for the release announcement contains 3 stories, this block will create 3 sections, with a heading for each story.

    Type / while editing the title field and select Issue sections in the AI blocks section.

    Issue lists

    Section titled “Issue lists”

    This block generates descriptions for all issues of the specified type(s) in a list format.

    For example: If the selection issue type was “Bug”, and the filter for the release announcement contains 5 bugs, this block will create 5 bullets points, one for each bug.

    Settings

    Section titled “Settings”

    Each template block can be filtered to show specific work items, and its AI prompt can be customized to override the global default.

    Filters

    Specify which work items appear in this block using one of three approaches:

    • Basic filters: Select work item types, status categories or labels directly from the dropdown menus.
    • Saved Jira filters: Pick from your existing Jira filters to reuse filter logic you’ve already defined.
    • JQL (advanced): Write a custom JQL query for full control over which issues are included.


    Use cases

    • Team-specific release notes: Add multiple Issue sections blocks, each filtered to a different team. This creates a dedicated section per team within a single release note — for example, one for Platform and one for Mobile.
    • Audience-targeted updates: Use filters to separate customer-facing improvements from internal changes, so you can publish relevant updates to different audiences.
    • Categorized bug reports: Combine an Issue sections block filtered to new features with an Issue lists block filtered to bug fixes, giving readers a clear picture of what’s new and what’s fixed.
    • Component-based changelogs: Filter by Jira component or label to organize release notes by product area, such as API, Dashboard, or Integrations.
    AI promptCustomize the AI prompt used for this section. Note that this only apply to newly generated descriptions. If the work item already has an existing changelog description, the existing descriotion will be used.

    Frequently Asked Questions

    Section titled “Frequently Asked Questions”
    Do you have any tips on how to write effective product updates?
    • Be Concise: Use the AI Summary for a quick overview and detailed sections for in-depth information.
    • Be Clear: Utilize headings and lists to structure your content for better readability.
    • Keep it Consistent: Stick to your template for a uniform look across all release notes.
    What happens if an issue in the template already has a description?

    That depends.

    If the description is stored in a released-description-field.md: Hub will use that description in the template and not generate a new description.

    If the description is stored in the issue properties (the default): Hub will overwrite the description only if a custom prompt was used in the template.