diff --git a/.ai/skills/CHANGELOG.md b/.ai/skills/CHANGELOG.md index 07962f9a3c..22f59a2204 100644 --- a/.ai/skills/CHANGELOG.md +++ b/.ai/skills/CHANGELOG.md @@ -16,6 +16,7 @@ including content-unchanged files, per the blog-creator convention). | igniteui-topic-frontmatter split: SKILL.md becomes a router (scope, audit-first mode, task table, hard boundaries); the field checks + severity ladder move to `references/audit-rules.md`; report shape + apply procedure move to `references/report-format.md`. `description` unchanged (adapter byte-match preserved). | igniteui-topic-frontmatter/* | | igniteui-doc-topics slimmed: SKILL.md keeps identity, two modes, compass, composite principle, task table, grounding boundaries. Create steps 1–7 (6a–6f) + the category/index structure move to `references/create-workflow.md`; the 5 audit-workflow steps move into `audit-rubric.md`. `description` unchanged. | igniteui-doc-topics/SKILL.md, references/create-workflow.md, references/audit-rubric.md | | Accessibility generation is source-first: derive DOM, roles, ARIA, focus/state behavior, and keyboard actions from component templates and typed source; use event handlers only for interaction evidence and require official sources for conformance claims. | igniteui-doc-topics/references/house-style.md, references/create-workflow.md | +| FAQ generation is component-specific and web-informed: derive question candidates from verified API/behavior and recurring public user questions, then verify answers against official source/API documentation and audit for generic or duplicated entries. | igniteui-doc-topics/references/house-style.md, references/create-workflow.md, references/audit-rubric.md | | Dedup (D2-03 stage 2): the section→mode map is no longer restated in SKILL.md — it is the "Diátaxis mode" column of house-style's canonical section table; SKILL.md keeps only the one-section-one-mode rule and the concrete mode-bleed examples. The category blueprint now lives in house-style + create-workflow only. Stale pointers fixed (house-style intro pointed at a SKILL.md map that moved; body-support bullet pointed at "Create workflow step 4" which now lives in create-workflow.md). | igniteui-doc-topics/SKILL.md, references/house-style.md | | Set-level README.md added: human-readable intent, file map, authority chain, and the five-step update procedure (edit references not routers; uniform version bump; adapter byte-match; changelog entry; resolve ‹VERIFY› by pre-committed outcome). | README.md | | Set-wide version line: every file now carries `Version: v3 · 2026-08-14 · igniteui doc-skill set`, including content-unchanged house-style and diataxis-cheatsheet (the cheatsheet gains its first version line). | all files | diff --git a/.ai/skills/igniteui-doc-topics/references/audit-rubric.md b/.ai/skills/igniteui-doc-topics/references/audit-rubric.md index 2a1c986d11..c2e3a4a7af 100644 --- a/.ai/skills/igniteui-doc-topics/references/audit-rubric.md +++ b/.ai/skills/igniteui-doc-topics/references/audit-rubric.md @@ -77,7 +77,11 @@ content for them. guidance. - A11 (Warning) **FAQ** uses plain question headings or hand-written accordion markup instead of the shared Astro `` / `` components, does not keep each answer concise and - component-specific, or an answer is not 2–4 self-contained sentences quotable without its question + component-specific, or an answer is not 2–4 self-contained sentences quotable without its question. + Also report generic questions, duplicated Usage/Troubleshooting content, questions unsupported by + the component's verified API or behavior, and FAQ sets with no evidence of considering recurring + public user questions for the component category. Recommend 3–6 questions covering distinct + high-value intents, with answers verified against official API/source documentation. (dangling "it"/"this", no subject noun). - A12 (Warning) A slot-mode FAQ does not set `indicatorPosition="end"` on every ``; setting it only on `` does not affect slotted children. diff --git a/.ai/skills/igniteui-doc-topics/references/create-workflow.md b/.ai/skills/igniteui-doc-topics/references/create-workflow.md index db35f97ca8..5b9dd38b2b 100644 --- a/.ai/skills/igniteui-doc-topics/references/create-workflow.md +++ b/.ai/skills/igniteui-doc-topics/references/create-workflow.md @@ -16,6 +16,10 @@ mechanics, and the frontmatter contract live in `house-style.md`; run the rubric matching Indigo.Design component documentation under `https://www.infragistics.com/products/indigo-design/help/components/` and use its component structure as input for Usage subsection suggestions. + For FAQ questions, inspect public web sources to identify recurring user question patterns for the + component category. Search the component name with `how to`, `not working`, `value`, `change`, + `disabled`, `keyboard`, `form`, `validation`, `accessibility`, and `when to use`; use results for + wording and intent discovery, then verify every answer against official API/source documentation. For the Accessibility section, inspect the component template/render method and typed source first: extract rendered native elements, `role`, `aria-*` attributes, focus and disabled conditions, and validation/selection state mapping. Read keyboard and pointer event handlers to @@ -57,7 +61,10 @@ mechanics, and the frontmatter contract live in `house-style.md`; run the rubric `indicatorPosition="end"` on every `FaqItem`, because the value on `Faq` does not flow into slotted children. When auditing, flag plain FAQ headings or custom accordion markup and convert each question/answer pair to an `FaqItem` while keeping the answer concise and - component-specific. + component-specific. Generate 3–6 questions from verified API behavior, recurring public web + questions, accessibility and keyboard behavior, common state/form failures, and the closest + alternative component. Keep each answer 2–4 self-contained sentences; do not copy + Troubleshooting or Usage steps verbatim. - **6e — Required sections check.** Include the required `### Prerequisites and Version Compatibility` subsection under **Getting Started**, and the required **Known Limitations**, **Related Components**, and **FAQ** sections in their canonical positions. A verified diff --git a/.ai/skills/igniteui-doc-topics/references/house-style.md b/.ai/skills/igniteui-doc-topics/references/house-style.md index 3412a1a42e..cdea1c6087 100644 --- a/.ai/skills/igniteui-doc-topics/references/house-style.md +++ b/.ai/skills/igniteui-doc-topics/references/house-style.md @@ -222,6 +222,31 @@ licensing/pricing, framework and version support, migration, accessibility, and "is ‹Component› right for ‹use case›". An FAQ whose answers cannot stand alone is markup without retrieval value — FAQ answers are among the most-quoted chunks on the page. +### FAQ question-generation contract + +Generate FAQ questions from the component's verified public surface and the questions users actually +ask about that kind of control. Build a question inventory from the API registry and typed source: +primary value or state, important inputs and events, form or validation integration, accessibility, +keyboard interaction, styling or rendering boundaries, and the closest alternative component. Then +search public web sources for recurring question shapes using the component name with `how to`, `not +working`, `value`, `change`, `disabled`, `keyboard`, `form`, `validation`, `accessibility`, and +`when to use`. + +- Use web results to discover user language, recurring confusion, and missing question types. Prefer + official Infragistics documentation, API docs, GitHub issues, and framework guidance. +- Treat web search as question discovery, never as authority for API behavior. Verify every answer + against component source/API and official framework documentation; omit or mark unresolved answers + with `‹VERIFY: source fact needed›`. +- Select 3–6 questions covering distinct, high-value intents. Prefer concrete outcomes, such as + “How do I set the Switch value?” or “Why is the Checkbox not changing when I press Space?” Avoid + generic questions such as “What is accessibility?”. +- Include a question only when its answer adds information not copied verbatim from another section. + Link to detailed Usage, Accessibility, Properties, or Troubleshooting content instead of repeating + steps. +- Do not force irrelevant categories onto simple primitives. Each answer must be 2–4 self-contained + sentences, repeat the component noun, and avoid undocumented defaults, browser support, or + conformance promises. + **When Not to Use trigger:** every component topic ends **Usage** with `### Do/Don't`. This subsection must include the matching guidance image from the Indigo.Design documentation before the guidance text. Use a repo-owned image import with ``; if the visual asset does not exist yet, leave a