ask_question Formatting Guidelines

Type: Architecture Standard
Status: Active
Pillar: 00_Engine

Context & Rationale

When using the ask_question tool to solicit user choices via interactive UI modals, vague or concatenated option labels (e.g. Option 1: True / No) create confusion and degrade user experience. Option labels MUST be self-contained, descriptive statements.

Core Rules

1. Self-Contained Labeling:

   • Each option text MUST be a complete, clear, and self-explanatory sentence or phrase.
   • Bad: "Option 1: True / No"
   • Good: "(Recommended) Synchronize projects.json so all 15 project definitions match"

2. First Option Recommendation:

   • The first option SHOULD be the recommended path and lead with the prefix (Recommended).

3. No Redundant “Other” Option:

   • Do NOT include an “Other” option in the list. The UI automatically renders a custom write-in field.

4. Clean Question Titles:

   • Do NOT include instructions like “Select one:” or “Select all that apply” in the question string. The UI handles multi-select formatting automatically via the is_multi_select boolean.

---

Part of the WayCup Engine Architecture. See 00_Engine/master_architecture.md for full system context.