> For the complete documentation index, see [llms.txt](https://developer.collibra.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.collibra.com/workflows/creating-workflows/workflow-basic-configuration-elements/workflow-description.md).

# Workflow description

The workflow description provides details about the purpose and general usage of a workflow.

You can add a description when creating new process models.

You can change the description of a workflow:

{% tabs %}
{% tab title="In Workflow Designer" %}
{% stepper %}
{% step %}
Select your app.
{% endstep %}

{% step %}
Select the process model.\ <i class="fa-chevrons-right">:chevrons-right:</i> The process editor appears.
{% endstep %}

{% step %}
In the attribute bar, in the **General** section, select the **Documentation** attribute.
{% endstep %}

{% step %}
Enter the workflow description.
{% endstep %}

{% step %}
Save your changes.
{% endstep %}
{% endstepper %}
{% endtab %}

{% tab title="In Collibra" %}
{% stepper %}
{% step %}
On the main toolbar, click <img src="https://2208542399-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAeKwSsP1BP6lDDArkTO2%2Fuploads%2Fgit-blob-c495609e46095abc7bbc4b08bd4d0e0beebb917a%2FProductsIcon.svg?alt=media" alt="Products icon" data-size="line"> → <img src="https://2208542399-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAeKwSsP1BP6lDDArkTO2%2Fuploads%2Fgit-blob-268a786d787f353b92e094a60945df32bf9cb208%2FCogwheelIcon.svg?alt=media" alt="Cogwheel icon" data-size="line"> **Settings**.\ <i class="fa-chevrons-right">:chevrons-right:</i> The **Settings** page opens.
{% endstep %}

{% step %}
Click **Workflows**.\ <i class="fa-chevrons-right">:chevrons-right:</i> The Workflows settings page appears on the **Definitions** tab page.
{% endstep %}

{% step %}
Select a workflow to view the definition settings.
{% endstep %}

{% step %}
In the **Description** section, click **Edit** to edit the description.
{% endstep %}

{% step %}
Click **Save** to apply your changes.
{% endstep %}
{% endstepper %}

{% hint style="info" %}
Uploading a workflow with a modified description also updates this field.
{% endhint %}
{% endtab %}

{% tab title="In the workflow BPMN" %}
Edit the `<documentation>` tag:

```
<process id="approvalProcess" name="Approval Process" isExecutable="true">
  <documentation>
    This is the main approval process for terms.
    The subject matter expert starts by reviewing the definition. 
    After that the stakeholders are given an opportunity to provide 
    comments on the given term. The subject matter expert is then given a 
    task to process the comments and the stewards are asked to vote for 
    term approval. The stakeholders are notified of the final outcome.
  </documentation>....
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developer.collibra.com/workflows/creating-workflows/workflow-basic-configuration-elements/workflow-description.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
