docs(glossary): add docs/glossary.md
This commit is contained in:
parent
f6c67ed37a
commit
cd68886953
1 changed files with 56 additions and 0 deletions
56
docs/glossary.md
Normal file
56
docs/glossary.md
Normal file
|
|
@ -0,0 +1,56 @@
|
|||
---
|
||||
title: "Scrum4Me — Glossary"
|
||||
status: active
|
||||
audience: [ai-agent, contributor]
|
||||
language: en
|
||||
last_updated: 2026-05-03
|
||||
when_to_read: "When you encounter a domain term and need its canonical definition and the doc where it is specified."
|
||||
---
|
||||
|
||||
# Scrum4Me — Glossary
|
||||
|
||||
Domain terms used across Scrum4Me docs, code, and MCP tooling.
|
||||
|
||||
## agent worker
|
||||
|
||||
A Claude Code session that has registered itself as a `ClaudeWorker` record and polls the job queue via `mcp__scrum4me__wait_for_job`. The NavBar counts active workers by `last_seen_at < now() - 15s`. See [MCP integration runbook](./runbooks/mcp-integration.md).
|
||||
|
||||
## claude-question
|
||||
|
||||
A pending question posted by an agent (via `mcp__scrum4me__ask_user_question`) to a human user, stored in the `claude_questions` table. The user answers in the UI; a PostgreSQL `LISTEN/NOTIFY` trigger pushes the answer back to the waiting agent. See [architecture: claude-question-channel](./architecture/claude-question-channel.md) and [ADR-0007](./adr/0007-claude-question-channel-design.md).
|
||||
|
||||
## demo-token
|
||||
|
||||
An API token whose owning user has `isDemo = true`. All write operations are blocked at three layers: the `proxy.ts` middleware, individual server actions, and disabled UI buttons. See [architecture: auth and sessions](./architecture/auth-and-sessions.md) and [ADR-0006](./adr/0006-demo-user-three-layer-policy.md).
|
||||
|
||||
## demo-user
|
||||
|
||||
A preconfigured read-only account used for public showcase. Shares product data with the main account but cannot create, update, or delete anything. See [architecture: auth and sessions](./architecture/auth-and-sessions.md).
|
||||
|
||||
## MCP-job
|
||||
|
||||
A `Task` record that has been queued for autonomous agent execution. An agent claims a job atomically via `mcp__scrum4me__wait_for_job` and reports completion via `mcp__scrum4me__update_job_status`. See [MCP integration runbook](./runbooks/mcp-integration.md).
|
||||
|
||||
## PBI (Product Backlog Item)
|
||||
|
||||
The second level of the work hierarchy: `Product → PBI → Story → Task`. A PBI groups related stories under a single theme or capability. Do not use "Epic", "Feature", or "Issue" as synonyms. See [backlog index](./backlog/index.md).
|
||||
|
||||
## Solo Panel
|
||||
|
||||
The single-user planning screen that shows all PBIs and stories for one product in a split-pane drag-and-drop layout. Contrast with the Sprint board (team-facing). See [functional spec — Solo Panel](./specs/functional.md).
|
||||
|
||||
## Sprint
|
||||
|
||||
A time-boxed iteration with a `sprint_goal`. Stories move from `OPEN` to `IN_SPRINT` when added to the active sprint. Only one sprint per product can be `ACTIVE` at a time. See [backlog index](./backlog/index.md).
|
||||
|
||||
## Story
|
||||
|
||||
The third level of the work hierarchy: `Product → PBI → Story → Task`. A Story has acceptance criteria and a status (`OPEN | IN_SPRINT | DONE`). See [functional spec](./specs/functional.md).
|
||||
|
||||
## Task
|
||||
|
||||
The leaf level of the work hierarchy: `Product → PBI → Story → Task`. A Task has an `implementation_plan`, a `status` (`TO_DO | IN_PROGRESS | REVIEW | DONE`), and an optional `sort_order`. API exposes status as lowercase (`todo | in_progress | review | done`). See [architecture: data model](./architecture/data-model.md) and [ADR-0004](./adr/0004-status-enum-mapping.md).
|
||||
|
||||
## Todo
|
||||
|
||||
A lightweight freeform note scoped to a product (or unscoped). Not part of the sprint hierarchy — used for quick capture. Created via `mcp__scrum4me__create_todo`. See [MCP integration runbook](./runbooks/mcp-integration.md).
|
||||
Loading…
Add table
Add a link
Reference in a new issue