> For the complete documentation index, see [llms.txt](https://docs.decisionrules.io/doc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.decisionrules.io/doc/rules/common-rule-features/rule-settings/rule-description.md).

# Rule description

The **Rule Description** provides a space where you can document the purpose and behavior of a rule. Clear descriptions help other users understand what the rule does, what inputs it expects, and how its logic should be interpreted.

<figure><img src="/files/VYc5qRZZ3zElNJ2C4TkZ" alt=""><figcaption></figcaption></figure>

#### Location

The **Description** field is located in the **right-side panel of the Rule Editor**, inside **Rule Settings → Description**.

#### Usage

You can enter explanatory text directly into the description field. The editor supports **basic rich text formatting**, which allows you to structure and highlight important information.

This makes it useful for documenting:

* the purpose of the rule
* explanations of input variables
* pricing logic or business conditions
* examples of how the rule behaves

#### Supported Formatting

The editor allows styling such as:

* **Bold text** for highlighting important values
* *Italic text* for emphasis
* Lists for structured information
* Headings for section separation
* Links to related documentation

#### Example

Below is a simple example of how a rule description can be structured:

**Ticket Price Calculation Rule**

This rule calculates the **final airline ticket price** based on several travel parameters.\
It evaluates the passenger's *origin*, *destination*, selected **travel class**, and the applied **fare tariff**.

The rule considers the following inputs:

* **Origin airport** – the departure location
* **Destination airport** – the arrival location
* **Travel class** – Economy, Business, or First Class
* **Fare tariff** – the pricing category applied to the ticket

Based on the combination of these values, the rule assigns the appropriate **ticket price** according to the configured pricing scenarios.


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.decisionrules.io/doc/rules/common-rule-features/rule-settings/rule-description.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.