LogoLogo
  • What is UDML?
  • Document structure
    • <components>
    • <imports>
    • <instructions>
    • <meta>
    • <styles>
    • <tokens>
    • <mappings>
    • <screens>
  • Directives
    • ai-hint
    • <data> Directive Specification
    • <interaction> Directive
    • <layer> Directive
    • <repeat> Directive
    • <responsive>
    • selection
    • <tracking> Directive
  • Components
    • Layout
      • <accordion> Component
      • <box> Component
      • <column> Component
      • <divider>
      • <grid> Component
      • <row> Component
    • Navigation
      • <breadcrumbs> Component
      • <pagination> Component
      • <tab> Component
      • <tabs> Component
    • Text & Display
      • <avatar>
      • <heading>
      • <icon>
      • <image>
      • <label>
      • <text>
      • <video>
    • Controls & Input
      • <button>
      • <checkbox>
      • <input> Component
      • <radio>
      • <select>
      • <slider>
      • <stepper>
      • <switch>
      • <textarea>
    • Forms
      • <form> Component
      • <formField> Component
      • <formGroup> Component
    • Data Collections
      • <dataColumn> Component
      • <dataTable> Component
      • <list> Component
      • <timeline> Component
      • <treeView> Component
    • Data Visualization
      • <chart> Component
      • <summary> Component
    • Modals
      • <dialog> Component
      • <modal> Component
      • <popover> Component
      • <toast> Component
      • <tooltip> Component
  • Prompting Guides
    • Prompting AI Developer Tools with UDML
    • Working with UDML in an Existing Codebase
  • Contributing to UDML
Powered by GitBook
On this page
  • 🧠 Purpose
  • 🛠 Syntax
  • 🧩 AI Interpretation Guidelines
  • ❌ Invalid Example
  • ✅ Example
Edit on GitHub
  1. Document structure

<instructions>

The <instructions> section provides natural language context for AI developer agents. It is not rendered visually, but guides how AI interprets, structures, and generates code from the UDML document.

🧠 Purpose

Use <instructions> to describe the intent of the product, the priorities of the design, the audience, tone, or any constraints. It's like writing a creative brief for an AI instead of a human team.

🛠 Syntax

<instructions>
  This is a mobile-first CRM dashboard for field agents.
  Prioritize quick access, offline functionality, and data clarity.
</instructions>

  • Only plain text is allowed.

  • Multiple lines are supported.

  • No attributes or children.

🧩 AI Interpretation Guidelines

  • AI tools should read this section before interpreting the UI structure.

  • Can influence layout decisions, component choice, tone, and visual styling.

  • May include business goals or UX principles.

❌ Invalid Example

<instructions><button>Click me</button></instructions>

✅ Example

<instructions>
  This is a simplified inventory management app for warehouse staff using tablets.
  Interfaces should be large-touch-friendly, with low-distraction visuals and minimal steps to complete a task.
</instructions>
Previous<imports>Next<meta>

Last updated 1 month ago