Structured clarification form for unresolved material requirements.
复制下面这句话,粘贴给 Claude Code、Codex、Cursor 等 AI 编程工具,它会读取安装说明并在你确认后完成安装。
请阅读 https://ai.atlankj.com/install/asset/gh-discovery-question-form-009b5404e706 ,按照其中的说明把「discovery-question-form」安装到你(当前 AI 工具)中。执行前先告诉我将运行的命令和写入的位置,等我确认。
查看 AI 将读取的安装说明正在读取 GitHub 原文…
内容来自 GitHub 原始文件,由原作者维护。在 GitHub 查看
This atom defines the <question-form> protocol. It does not decide whether
clarification is required. Follow the active skill and core prompt's
requirements-clarification policy. When they identify unresolved information
that would materially change the design direction, content structure, or
delivery format, surface the smallest possible set of questions that unblocks
the workflow.
The questions are rendered as a <question-form> artifact inline in the
originating assistant message. This is assistant text parsed by the host, not a
plugin GenUI surface or a native tool call. Submitted answers return as the
next user message, beginning with [form answers — <form-id>].
discovery pipeline stage only makes this protocol available; declaring
or entering the stage does not trigger a form.Emit the form as a question-form block whose body is a JSON object with a
top-level questions array. Do not emit a bare question object by itself; the
renderer only recognizes the wrapped form contract.
The example below shows field shapes, not a fixed questionnaire. Include only unresolved questions and derive their recommendations from the actual brief; these example values are not fallback answers. A reference file remains unanswered until supplied.
<question-form id="discovery" title="Quick brief — 30 seconds">
{
"description": "I'll lock these in before building. Skip what doesn't apply — I'll fill defaults.",
"questions": [
{
"id": "audience",
"label": "Who's the primary audience?",
"type": "checkbox",
"default": ["Customer"],
"options": ["VC", "Customer", "Internal team"],
"maxSelections": 2,
"required": true
},
{
"id": "format",
"label": "Which format should I use?",
"type": "radio",
"default": "landscape",
"options": [
{ "label": "Portrait", "value": "portrait" },
{ "label": "Landscape", "value": "landscape" }
]
},
{
"id": "language",
"label": "Which language should the promo use?",
"type": "select",
"default": "en",
"options": [
{ "label": "Chinese", "value": "zh-CN" },
{ "label": "English", "value": "en" },
{ "label": "French", "value": "fr" },
{ "label": "German", "value": "de" },
{ "label": "Japanese", "value": "ja" },
{ "label": "Spanish", "value": "es" }
]
},
{
"id": "reference",
"label": "Add a reference file if available",
"type": "file",
"required": false
}
]
}
</question-form>
Each entry in the top-level questions array uses:
id: stable answer key, for example audience.label: user-facing question copy.type: one of radio, checkbox, select, text, textarea,
number, range, date, time, datetime-local, color, url,
email, tel, file, or switch.default: the recommended answer inferred from the brief, project metadata,
plugin inputs, and known context. Use an option's stable value for radio
or select, an array of option values for checkbox, and concrete suggested
text for free-text fields. String options use the exact option string as
their value. Respect maxSelections; never substitute localized labels for
stable values. The host also accepts the defaultValue alias; emit only one
of these fields per question.default only when no reasonable recommendation exists, such as a file upload.
Do not invent a missing fact or select the first option merely because it is
first. A recommendation written only in description does not preselect an
answer: encode it in the default field. Place that field before options so
it arrives before a long option list during streaming.options: required for choice controls; strings are
allowed, or objects with localized label and stable value.radio vs select by option count, not importance: radio for a short list, select once it runs long (languages, timezones, voices). checkbox is always a plain list.select options may carry group (first group expands, the rest collapse) and trailingLabel (a short end-of-row code such as ZH-CN). Both optional.label; never change a stable value.label under ~40 characters; put anything longer in description.The discovery atom completes when the next user message contains an answer for every required question. Treat those submitted answers as conversation context and do not ask the same questions again unless later input invalidates an answer.
allowCustom: leave unset or set to true for finite-choice controls so
users can type their own answer instead of accepting only generated options.
Set allowCustom: false only when the downstream system needs an exact
machine id.customLabel / customPlaceholder: optional localized copy for that custom
answer input.maxSelections: include this for checkbox controls with a limited selection
count.required: set to true only when the answer is needed before work can
continue.