-
Notifications
You must be signed in to change notification settings - Fork 17
docs(chatbot): add component pages #244
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: development
Are you sure you want to change the base?
Changes from all commits
09a961b
2b24d18
d4a9fd9
ef92031
e9c70ba
1a5a251
49c2eb8
d2d60e0
5231dcb
ad8288b
138bf85
47430e6
db3c924
b4175bf
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| DOCS_BRANCH='main' | ||
| DOCS_BRANCH_TYPE='pull request' # Check if the branch is a pull request | ||
| DOCS_PR_NUMBER='2569' |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,277 @@ | ||
| --- | ||
| name: sdd | ||
| description: >- | ||
| Spec-Driven Development for Siemens IX: turns user-provided issue or tracking text | ||
| into spec.md, plan.md, and tasks.md (GitHub spec-kit style, size-aware, no tracker integration). | ||
| Use when the user asks for SDD, spec-kit planning, or structured feature docs from issue text | ||
| (e.g. IX-1234 plus pasted description). Outputs live under .sdd/{tracking-id}/. | ||
| argument-hint: 'Tracking/issue id (e.g. IX-3896) and pasted title, description, acceptance criteria' | ||
| user-invocable: true | ||
| --- | ||
|
|
||
| # Spec-Driven Development (IX) | ||
|
|
||
| ## Overview | ||
|
|
||
| Transform **user-provided issue or tracking text** (no tracker integration required) into structured specifications following **GitHub spec-kit methodology**: clear separation, progressive disclosure, minimal duplication. | ||
|
|
||
| **When to use**: User wants SDD / spec planning for an IX change and supplies (or will supply) a tracking/issue identifier plus title, description, and acceptance criteria as plain text. | ||
|
|
||
| ## Required input (no tracker integration) | ||
|
|
||
| Before Phase 1, confirm you have: | ||
|
|
||
| 1. **Tracking/issue identifier** (e.g. `IX-3896`, issue number, ticket key) β if missing, ask once; if still missing, derive a short folder slug from the title (lowercase, hyphens, max ~40 chars). | ||
| 2. **Issue title** (summary line). | ||
| 3. **Description** β user story, context, bullets, links as pasted. | ||
| 4. **Acceptance criteria** β pasted AC block or checklist from the issue/tracking source. | ||
|
|
||
| If the user only pastes prose without clear AC, extract implied AC into the spec and add a **Clarifications** note listing assumptions. | ||
|
|
||
| **Do not** call tracker APIs or assume an MCP; treat the chat message as the source of truth. | ||
|
|
||
| ## Key principles | ||
|
|
||
| 1. **Separation**: `spec.md` (WHAT), `plan.md` (HOW), `tasks.md` (DO) β no duplication. | ||
| 2. **Tech-agnostic specs**: Requirements do not name Stencil/React/etc. | ||
| 3. **Size-aware output**: XS compact; L fuller (see below). | ||
| 4. **Line limits**: Each artifact file under 500 lines. | ||
| 5. **Progressive disclosure**: Read spec β plan β tasks when implementing. | ||
|
|
||
| ## Workflow phases | ||
|
|
||
| ``` | ||
| Pasted issue text β Specify β Review β Clarify β Review β Plan β Review β Tasks β Review β Implement | ||
| β β β β | ||
| spec.md spec.md plan.md tasks.md | ||
| ``` | ||
|
|
||
| **Mandatory phase gates**: | ||
|
|
||
| After creating or updating each artifact, stop and ask the user to review the created file before continuing: | ||
|
|
||
| 1. After `spec.md`: ask whether to continue to planning or revise the spec. | ||
| 2. After updated `spec.md` clarifications: ask whether to continue to planning or revise the clarified spec. | ||
| 3. After `plan.md`: ask whether to continue to task breakdown or revise the plan. | ||
| 4. After `tasks.md`: ask whether to implement, revise tasks, or stop at handoff. | ||
|
|
||
| Do **not** proceed to the next phase automatically after writing an artifact. If the runtime provides an `ask_user` tool, use it for these phase gates instead of asking in plain text. | ||
|
|
||
| If the XS strategy omits `spec.md` or `tasks.md`, skip only the omitted file's review gate; still stop after the merged `plan.md` and ask the user to review it before implementation. | ||
|
|
||
| ### Phase 1: Specify (requirements) | ||
|
|
||
| Create `spec.md` from the pasted issue only (optional: spawn a read-only explore subagent for codebase context **after** spec is drafted if gaps exist β do not block spec on repo-wide search). | ||
|
|
||
| **Output path**: `.sdd/{TRACKING_ID}/spec.md` (use the agreed tracking/issue identifier or slug for `{TRACKING_ID}`). | ||
|
|
||
| **Review gate**: After writing `spec.md`, stop and ask the user to review `.sdd/{TRACKING_ID}/spec.md`. Continue only when the user approves moving to planning; otherwise revise `spec.md` first. | ||
|
|
||
| **Frontmatter**: | ||
|
|
||
| ```yaml | ||
| --- | ||
| tracking_id: {ID or slug} | ||
| feature: {TITLE} | ||
| date: {ISO date} | ||
| status: ready-for-planning | ||
| source: user-pasted-issue | ||
| --- | ||
| ``` | ||
|
|
||
| **Body template** (adapt length to size tier): | ||
|
|
||
| ```markdown | ||
| # Feature Spec: {TITLE} | ||
|
|
||
| ## User input (from issue) | ||
| {2β5 lines summarizing pasted description β no copy-paste dump of entire ticket} | ||
|
|
||
| ## User scenarios and testing | ||
|
|
||
| ### US1 [P1] - {Scenario} | ||
| **As** {role} | ||
| **I want** {goal} | ||
| **So that** {benefit} | ||
|
|
||
| **Acceptance scenarios:** | ||
| **Given** {context} | ||
| **When** {action} | ||
| **Then** {outcome} | ||
|
|
||
| **Edge cases:** {if any} | ||
|
|
||
| ## Requirements | ||
|
|
||
| ### Functional requirements | ||
| **FR-001**: {requirement} | ||
| **FR-002**: {requirement} | ||
|
|
||
| ### Key entities | ||
| {Only if data or domain models matter} | ||
|
|
||
| ## Success criteria | ||
| **SC-001**: {measurable outcome} | ||
| **SC-002**: {measurable outcome} | ||
|
|
||
| ## Assumptions | ||
| {Scope boundaries, dependencies on other IX areas} | ||
| ``` | ||
|
|
||
| **Size guide (spec.md only)**: | ||
|
|
||
| - XS: ~40 lines | ||
| - S: ~80 lines | ||
| - M: ~100 lines | ||
| - L: ~150 lines | ||
|
|
||
| ### Phase 2: Clarify (optional) | ||
|
|
||
| If requirements are ambiguous, ask targeted questions in chat; when answered, append to `spec.md`: | ||
|
|
||
| ```markdown | ||
| ## Clarifications | ||
|
|
||
| **Q1**: β¦ | ||
| **A**: β¦ | ||
| ``` | ||
|
|
||
| **Review gate**: After adding clarifications, stop and ask the user to review the updated `.sdd/{TRACKING_ID}/spec.md`. Continue only when the user approves moving to planning; otherwise revise `spec.md` first. | ||
|
|
||
| ### Phase 3: Plan (technical approach) | ||
|
|
||
| **Output**: `.sdd/{TRACKING_ID}/plan.md` | ||
|
|
||
| 1. Read `spec.md`. | ||
| 2. Align with IX repo: skim `CONTRIBUTING.md` and relevant package/component paths touched; follow existing patterns in the monorepo. | ||
| 3. Record technical decisions with short rationale; **do not** repeat requirements from `spec.md` β reference them (`See spec.md US1`). | ||
|
|
||
| **Plan frontmatter**: | ||
|
|
||
| ```yaml | ||
| --- | ||
| tracking_id: {ID or slug} | ||
| phase: plan | ||
| created: {ISO date} | ||
| depends_on: [] | ||
| --- | ||
| ``` | ||
|
|
||
| **Sections**: Summary, Technical context (language, packages, tests), Architecture (decisions with alternatives rejected), Implementation structure, Risks and mitigations, Deployment strategy only if non-trivial. | ||
|
|
||
| **Review gate**: After writing `plan.md`, stop and ask the user to review `.sdd/{TRACKING_ID}/plan.md`. Continue only when the user approves creating tasks; otherwise revise `plan.md` first. | ||
|
|
||
| **Size guide (plan.md)**: | ||
|
|
||
| - XS: merge spec + plan into a **single** `plan.md` only (~80 lines total) β skip separate `spec.md` only when doing XS merge (see XS strategy below). | ||
| - S: ~120 lines | ||
| - M: ~150 lines | ||
| - L: ~200 lines | ||
|
|
||
| ### Phase 4: Tasks (implementation steps) | ||
|
|
||
| **Output**: `.sdd/{TRACKING_ID}/tasks.md` | ||
|
|
||
| Ordered steps; each task: id, file path in repo, action, optional snippet, dependencies. Mark parallelizable tasks with `[P]`. Do not repeat plan rationale. | ||
|
|
||
| **Review gate**: After writing `tasks.md`, stop and ask the user to review `.sdd/{TRACKING_ID}/tasks.md`. Implement only if the user explicitly approves implementation; otherwise revise `tasks.md` or stop at handoff. | ||
|
|
||
| **Size guide (tasks.md)**: | ||
|
|
||
| - XS: omit `tasks.md` (implement from merged plan). | ||
| - S: ~100 lines | ||
| - M: ~150 lines | ||
| - L: ~200 lines | ||
|
|
||
| ### Phase 5: Research (optional) | ||
|
|
||
| Create `research.md` only for unusual dependency or API verification β not for routine Stencil/Playwright usage. | ||
|
|
||
| **Output**: `.sdd/{TRACKING_ID}/research.md` (<300 lines). | ||
|
|
||
| ## XS output strategy | ||
|
|
||
| For **XS** (<~2h) work: | ||
|
|
||
| - Produce **one** file: `.sdd/{TRACKING_ID}/plan.md` (~80 lines) that merges concise requirements + approach + minimal task list + validation checklist. | ||
| - Omit separate `spec.md` / `tasks.md` unless the user explicitly wants full spec-kit layout. | ||
| - Stop after writing the merged `plan.md` and ask the user to review it before implementation. | ||
|
|
||
| ## S / M / L output strategy | ||
|
|
||
| | Tier | Outputs | Approx. total lines | | ||
| |------|---------|---------------------| | ||
| | S | spec.md + plan.md + tasks.md | ~300 | | ||
| | M | spec.md + plan.md + tasks.md | ~400 | | ||
| | L | spec.md + plan.md + tasks.md (+ optional research.md) | ~600 | | ||
|
|
||
| Classify size from pasted story points, AC count, and breadth (single component vs cross-package). | ||
|
|
||
| ## Anti-duplication rules | ||
|
|
||
| Before each paragraph: | ||
|
|
||
| 1. Already in `spec.md`? β Link, do not repeat. | ||
| 2. Technical decision? β `plan.md` only. | ||
| 3. Implementation step? β `tasks.md` only. | ||
| 4. Obvious to an IX maintainer? β Skip (standard monorepo test commands, changeset rules β point to existing skills if needed). | ||
| 5. Project-wide rule? β Reference `CONTRIBUTING.md` or the relevant package README. | ||
|
|
||
| **Cross-reference pattern**: | ||
|
|
||
| ```markdown | ||
| See spec.md US1 for acceptance criteria. | ||
| See plan.md Architecture for rationale. | ||
| ``` | ||
|
|
||
| ## File layout | ||
|
|
||
| ```text | ||
| .sdd/{TRACKING_ID}/ | ||
| βββ spec.md # Requirements (tech-agnostic) | ||
| βββ plan.md # Technical approach | ||
| βββ tasks.md # Implementation steps | ||
| βββ research.md # Optional tech verification | ||
| ``` | ||
|
|
||
| Do **not** generate `narrative.md` or standalone `alternatives.md` β keep decisions inline in `plan.md`. | ||
|
|
||
| ## Context management | ||
|
|
||
| - **Main chat**: clarify scope, write `plan.md` / `tasks.md`, discuss trade-offs. | ||
| - **Read-only exploration**: large codebase search to ground `plan.md` paths β use sparingly after `spec.md` exists. | ||
|
|
||
| ## Implementation handoff | ||
|
|
||
| When artifacts are ready: | ||
|
|
||
| ```text | ||
| Specification complete for {TRACKING_ID}. | ||
|
|
||
| Files: | ||
| - spec.md β requirements | ||
| - plan.md β technical approach | ||
| - tasks.md β steps (if created) | ||
|
|
||
| Next: implement a task, all tasks in order, or revise the plan β say which you prefer. | ||
| ``` | ||
|
|
||
| ## Quality checklist | ||
|
|
||
| **spec.md**: Tech-agnostic; Given/When/Then where applicable; numbered FRs; measurable success criteria; <500 lines. | ||
|
|
||
| **plan.md**: No requirement duplication; decisions with 1β2 line rationale; references spec; IX-realistic paths; <500 lines. | ||
|
|
||
| **tasks.md**: Exact repo paths; dependency order; `[P]` for parallel; no decision essays; <500 lines. | ||
|
|
||
| **Overall**: No cross-file duplication; size tier matches work; each file has one job. | ||
|
|
||
| ## IX-specific notes | ||
|
|
||
| - Prefer paths under `packages/core`, `packages/angular`, `packages/react`, `packages/documentation`, etc., as appropriate β discover real paths from the tree, do not invent directories. | ||
| - Testing and release hygiene: use existing project skills (component tests, Storybook a11y, changesets) when the userβs workflow requires them; do not restate full skill bodies here. | ||
|
|
||
| ## References | ||
|
|
||
| - [GitHub spec-kit](https://github.com/github/spec-kit) | ||
| - Project skill definition: `.github/skills/sdd/SKILL.md` β this repo skill uses pasted issue/tracking text and `.sdd/β¦` for generated artifacts. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| --- | ||
| doc-type: 'tab-item' | ||
| description: 'Code examples and API documentation for AI message' | ||
| --- | ||
|
|
||
| import ChatAiMessagePlayground from '@site/docs/autogenerated/playground/chat-ai-message.mdx'; | ||
| import PropsApi from '@site/docs/autogenerated/api/ix-chat-ai-message/api.mdx'; | ||
|
|
||
| # AI message - Code | ||
|
|
||
| ## Basic | ||
|
|
||
| <ChatAiMessagePlayground height="24rem" /> | ||
|
|
||
| <PropsApi /> | ||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,37 @@ | ||||||
| --- | ||||||
| doc-type: 'tab-item' | ||||||
| description: 'Usage guide for AI message' | ||||||
| --- | ||||||
|
|
||||||
| # AI message - Usage | ||||||
|
|
||||||
| AI messages display a single assistant response inside a conversational thread. We recommend using them for answers users need to read, review and act on. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Question: is the component for the prompt input field the same as the message component? |
||||||
|
|
||||||
|  | ||||||
|
|
||||||
| 1. Content | ||||||
| 2. Actions | ||||||
|
|
||||||
| ## Options | ||||||
|
|
||||||
| - **Content:** Keep the response easy to scan. We usually structure longer answers with a short lead sentence followed by lists, short paragraphs or other lightweight content blocks. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is recommended but we have no control over the format of the response. Instead here you should say what the font type and font size is. And the font color as we can control this. If we have this info and if suitable here. If you want to give recommendations about AI behavior feedback you can refer to: https://ix.siemens.io/docs/guidelines/conversational-design/designing-conversations/overview |
||||||
| - **Actions:** Add only message-level actions that users expect after reading, e.g. copy, rate response quality or regenerate. We recommend using subtle tertiary [icon buttons](../icon-button) so actions stay available without competing with the answer. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Question: Is regenerate usually within this component? Please refer to the AI terminology Figma file for wording with action icons: https://www.figma.com/design/lqjt9c5IzzwQ4eJ4nqG7Kv/AI-Terminology?node-id=1-9&t=d5UkOPKJfj9qDmYM-1 ONLY INTERNAL |
||||||
| - **Sources:** If the response is grounded in files, web results or internal data, expose that provenance close to the message content, e.g. with [chips](../chip). Only show sources when they are real and inspectable. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There are two kinds of resources - inline and also under the message box. Do we want to talk about both? I think both use chips. Need to check. Also note "Only show sources when they are real and inspectable." - this must be removed as it is not possible to control.
Suggested change
|
||||||
|
|
||||||
| ## Behavior in context | ||||||
|
|
||||||
| - **Responsiveness:** AI messages use from 45 to 80 % of the chat's container width, depending on the viewport width. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| ## Dos and Donβts | ||||||
|
|
||||||
| - Do structure longer responses into short paragraphs or lists so users can scan them quickly | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. remove - cant have this do
Suggested change
|
||||||
| - Do show clear [loading indicators](../spinner/) while the assistant is processing | ||||||
|
kathrinschalber marked this conversation as resolved.
kathrinschalber marked this conversation as resolved.
|
||||||
| - Do show sources or evidence when the response refers to external or retrieved information | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| - Don't overuse actions by focusing only on the few actions users commonly need after reading, e.g. copy, feedback, regenerate | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. maybe would make this a do: "Do use the same actions for each AI message for consistency, but no more than 4 to avoid overloading users" |
||||||
| - Donβt present speculative or low-confidence output as if it were verified fact | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| ## Related | ||||||
|
|
||||||
| - [Chat](../chat) | ||||||
| - [User message](../user-message) | ||||||
| - [Chat input](../chat-input) | ||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| doc-type: "tabs" | ||
| description: 'Used to display a single response generated by the AI in a conversational chats' | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. usually these have full stops yes? |
||
| title: 'AI message' | ||
| deprecated: | ||
| --- | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| --- | ||
| doc-type: 'tab-item' | ||
| description: 'Code examples and API documentation for AI message' | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. .? |
||
| --- | ||
|
|
||
| import ChatAttachmentPlayground from '@site/docs/autogenerated/playground/chat-user-message.mdx'; | ||
| import PropsApi from '@site/docs/autogenerated/api/ix-chat-prompt-attachment/api.mdx'; | ||
|
|
||
| # Chat attachment - Code | ||
|
|
||
| ## Basic | ||
|
|
||
| <ChatAttachmentPlayground height="24rem" /> | ||
|
|
||
| <PropsApi /> | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should these be with full stops?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Up till now, we had them without