> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/dev-guide/developer-guide-en/pjt-prepare/ui-ux-guide/patterns/directive-error-comment-writing-guide.md).

# Directive/Error/Comment Writing Guide

## Output Format and Method <a href="#undefined" id="undefined"></a>

1. The following types of content are shown in the status bar at the bottom of the workspace screen.
   * Message popup
   * Area adjacent to the relevant component on the screen
   * Status Bar
   * Simple notification message
2. All messages are displayed based on information managed by the server.
3. A status bar is also added to popups to indicate the message processing status in the same way.
4. When there are many comments on a page, they are indicated with an icon, and the content is shown in a layer popup.

## Directives <a href="#undefined" id="undefined"></a>

1. Informational directives are stated in a definitive form.
2. Suggestive/recommending directives are composed of sentences that can guide the user's choice.

## Help <a href="#undefined" id="undefined"></a>

Help for the relevant item is indicated as an icon and shown as a layer on mouse-over; it disappears when the mouse leaves that area.

## Guidance Text <a href="#undefined" id="undefined"></a>

1. Guidance text is placed at the bottom left.
2. Sentences are finished in a descriptive form.
3. A '.' bullet mark is used in front of the sentence.
4. Guidance text that applies to the entire screen is placed according to importance.
5. General guidance text is applied as Normal, and important guidance text is applied as Bold.
6. When there is a group box, it is written at the bottom left inside the group box.

## Examples of Notation by Situation <a href="#undefined" id="undefined"></a>

<br>

<figure><img src="https://tech.x2bee.com/download/attachments/14550123/UIUX%20-%20%EC%A7%80%EC%8B%9C%EB%AC%B8_%EC%98%A4%EB%A5%98_%EC%A3%BC%EC%84%9D.png" alt=""><figcaption></figcaption></figure>
