@kudusov.takhir/ba-toolkit 1.2.0

package/skills/references/templates/apicontract-template.md

@@ -0,0 +1,183 @@
+# API Contract: [PROJECT_NAME]
+
+**Domain:** [DOMAIN]
+**Date:** [DATE]
+**Slug:** [SLUG]
+**API Style:** REST | GraphQL | gRPC
+**Base URL:** `https://api.[domain].com/v1`
+**Auth:** Bearer JWT | API Key | OAuth 2.0
+**References:** `02_srs_[SLUG].md`, `07_datadict_[SLUG].md`
+
+---
+
+## Authentication
+
+```
+Authorization: Bearer <token>
+```
+
+Token obtained via `POST /auth/token`. Expires in [N] minutes. Refresh via `POST /auth/refresh`.
+
+---
+
+## Conventions
+
+- Dates: ISO 8601 (`2026-04-07T10:00:00Z`)
+- IDs: UUID v4
+- Pagination: cursor-based — `?cursor=[cursor]&limit=[N]`
+- Errors: `{ "error": { "code": "ERROR_CODE", "message": "Human-readable message" } }`
+- Amounts: stored and returned in minor units (e.g. cents)
+
+---
+
+## Endpoints
+
+### POST /[resource]
+
+**Description:** [What this endpoint does.]
+**Auth required:** Yes | No
+**Linked FR:** FR-[NNN] | **Linked Story:** US-[NNN]
+
+**Request body:**
+
+```json
+{
+  "[field]": "[type — description]",
+  "[field]": "[type — description]"
+}
+```
+
+**Response `201 Created`:**
+
+```json
+{
+  "id": "uuid",
+  "[field]": "[value]"
+}
+```
+
+**Error responses:**
+
+| Code | Error Code | Description |
+|------|-----------|-------------|
+| 400 | VALIDATION_ERROR | [Which fields, which rule] |
+| 401 | UNAUTHORIZED | Missing or invalid token |
+| 409 | [CONFLICT_CODE] | [Conflict condition] |
+
+---
+
+### GET /[resource]
+
+**Description:** [What this endpoint returns.]
+**Auth required:** Yes | No
+**Query parameters:**
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| cursor | String | No | Pagination cursor |
+| limit | Int | No | Max items (default 20, max 100) |
+| [filter] | [type] | No | [Description] |
+
+**Response `200 OK`:**
+
+```json
+{
+  "data": [
+    {
+      "id": "uuid",
+      "[field]": "[value]"
+    }
+  ],
+  "pagination": {
+    "next_cursor": "[cursor or null]",
+    "has_more": true
+  }
+}
+```
+
+---
+
+### GET /[resource]/:id
+
+**Description:** [What this endpoint returns.]
+**Auth required:** Yes | No
+
+**Response `200 OK`:**
+
+```json
+{
+  "id": "uuid",
+  "[field]": "[value]"
+}
+```
+
+**Error responses:**
+
+| Code | Error Code | Description |
+|------|-----------|-------------|
+| 404 | NOT_FOUND | Resource does not exist |
+
+---
+
+### PATCH /[resource]/:id
+
+**Description:** [What this endpoint updates.]
+**Auth required:** Yes
+**Linked FR:** FR-[NNN]
+
+**Request body** (all fields optional):
+
+```json
+{
+  "[field]": "[new value]"
+}
+```
+
+**Response `200 OK`:** Updated resource object.
+
+---
+
+### DELETE /[resource]/:id
+
+**Description:** [Soft or hard delete — specify.]
+**Auth required:** Yes
+
+**Response `204 No Content`**
+
+<!-- Repeat endpoint blocks as needed. Group by resource. -->
+
+---
+
+## Webhooks
+
+### [event.name]
+
+**Trigger:** [When this event fires]
+**Payload:**
+
+```json
+{
+  "event": "[event.name]",
+  "timestamp": "2026-04-07T10:00:00Z",
+  "data": {
+    "[field]": "[value]"
+  }
+}
+```
+
+**Retry policy:** [N] retries with exponential backoff. Delivery considered failed after [N] hours.
+
+---
+
+## Error Code Reference
+
+| HTTP Code | Error Code | Meaning |
+|-----------|-----------|---------|
+| 400 | VALIDATION_ERROR | Request body or params fail validation |
+| 401 | UNAUTHORIZED | Missing, expired, or invalid token |
+| 403 | FORBIDDEN | Authenticated but insufficient permissions |
+| 404 | NOT_FOUND | Resource does not exist |
+| 409 | CONFLICT | State conflict (duplicate, wrong status) |
+| 422 | BUSINESS_RULE_ERROR | Request is valid but violates a business rule |
+| 429 | RATE_LIMITED | Too many requests |
+| 500 | INTERNAL_ERROR | Unexpected server error |

package/skills/references/templates/brief-template.md

@@ -0,0 +1,51 @@
+# Project Brief: [PROJECT_NAME]
+
+**Domain:** [DOMAIN]
+**Date:** [DATE]
+**Slug:** [SLUG]
+
+## 1. Project Summary
+
+[One paragraph describing what is being built, for whom, and why.]
+
+## 2. Business Goals and Success Metrics
+
+| # | Goal | Success Metric |
+|---|------|---------------|
+| 1 | [goal] | [measurable metric] |
+
+## 3. Target Audience
+
+| Segment | Description | Geography |
+|---------|-------------|-----------|
+| [segment] | [description] | [region] |
+
+## 4. High-Level Functionality Overview
+
+[2–4 paragraphs or bullet list of the main functional areas. No technical detail — what the system does, not how.]
+
+## 5. Stakeholders and Roles
+
+| Role | Responsibility | Interest |
+|------|---------------|---------|
+| [role] | [what they do] | [what they care about] |
+
+## 6. Constraints and Assumptions
+
+**Constraints:**
+- [constraint]
+
+**Assumptions:**
+- [assumption]
+
+## 7. Risks
+
+| # | Risk | Probability | Impact | Mitigation |
+|---|------|-------------|--------|-----------|
+| 1 | [risk] | High/Med/Low | High/Med/Low | [mitigation] |
+
+## 8. Glossary
+
+| Term | Definition |
+|------|-----------|
+| [term] | [definition] |

package/skills/references/templates/datadict-template.md

@@ -0,0 +1,75 @@
+# Data Dictionary: [PROJECT_NAME]
+
+**Domain:** [DOMAIN]
+**Date:** [DATE]
+**Slug:** [SLUG]
+**References:** `02_srs_[SLUG].md`, `03_stories_[SLUG].md`
+
+---
+
+## Entity: [EntityName]
+
+**Description:** [What this entity represents in the domain.]
+**Table / Collection:** `[table_name]`
+**Linked FR:** FR-[NNN]
+
+| Field | Type | Required | Default | Description | Constraints |
+|-------|------|----------|---------|-------------|------------|
+| id | UUID | Yes | auto | Primary key | Unique |
+| [field] | [String \| Int \| Boolean \| Timestamp \| Decimal \| Enum \| FK] | Yes/No | [value or —] | [description] | [constraints, e.g. max 255, ≥ 0] |
+| created_at | Timestamp | Yes | now() | Record creation time | |
+| updated_at | Timestamp | Yes | now() | Last update time | |
+
+**Relationships:**
+- `[EntityName]` belongs to `[OtherEntity]` via `[field]` (many-to-one)
+- `[EntityName]` has many `[OtherEntity]` (one-to-many)
+
+**Indexes:**
+- `[field]` — for [reason, e.g. lookup by email]
+
+**Soft delete:** Yes — `deleted_at` field / No — hard delete
+**Notes:** [Business rules, state machine, or special handling.]
+
+---
+
+## Entity: [EntityName2]
+
+**Description:** [What this entity represents in the domain.]
+**Table / Collection:** `[table_name]`
+**Linked FR:** FR-[NNN]
+
+| Field | Type | Required | Default | Description | Constraints |
+|-------|------|----------|---------|-------------|------------|
+| id | UUID | Yes | auto | Primary key | Unique |
+| [field] | [type] | Yes/No | [value] | [description] | [constraints] |
+| created_at | Timestamp | Yes | now() | Record creation time | |
+| updated_at | Timestamp | Yes | now() | Last update time | |
+
+**Relationships:**
+- [relationship description]
+
+**Soft delete:** Yes / No
+**Notes:** [Special handling.]
+
+<!-- Repeat Entity block for each domain entity. -->
+
+---
+
+## Enum Definitions
+
+### [EnumName]
+
+| Value | Label | Description |
+|-------|-------|-------------|
+| [VALUE] | [Display label] | [When this value applies] |
+
+---
+
+## Entity Relationship Overview
+
+```
+[EntityName] ──< [EntityName2]
+[EntityName2] >── [EntityName3]
+```
+
+_Full ERD: generated separately by the development team._

package/skills/references/templates/export-template.md

@@ -0,0 +1,112 @@
+# Export Template
+
+Template showing the structure of `/export` output files for each supported format.
+Actual values are filled in by the skill based on the project's artifacts.
+
+---
+
+## Jira JSON — `export_{slug}_jira.json`
+
+```json
+{
+  "projects": [
+    {
+      "key": "PROJ",
+      "issues": [
+        {
+          "summary": "US-001: User can register with email and password",
+          "description": {
+            "type": "doc",
+            "version": 1,
+            "content": [
+              {
+                "type": "paragraph",
+                "content": [{ "type": "text", "text": "As a visitor, I want to register with my email and password, so that I can access my personal account." }]
+              },
+              {
+                "type": "heading",
+                "attrs": { "level": 3 },
+                "content": [{ "type": "text", "text": "Acceptance Criteria" }]
+              },
+              {
+                "type": "bulletList",
+                "content": [
+                  { "type": "listItem", "content": [{ "type": "paragraph", "content": [{ "type": "text", "text": "Given I am on the registration page, When I submit a valid email and password, Then my account is created and I am redirected to the dashboard." }] }] },
+                  { "type": "listItem", "content": [{ "type": "paragraph", "content": [{ "type": "text", "text": "Given I submit an email that already exists, When the form is submitted, Then I see an error message 'Email already in use'." }] }] }
+                ]
+              }
+            ]
+          },
+          "issuetype": { "name": "Story" },
+          "priority": { "name": "High" },
+          "labels": ["dragon-fortune", "E-01"],
+          "customfield_10016": 3,
+          "customfield_10014": null
+        }
+      ]
+    }
+  ]
+}
+```
+
+**Import:** Jira → Project Settings → Issue Import → JSON Import, or `jira import --file export_{slug}_jira.json`
+
+---
+
+## GitHub Issues JSON — `export_{slug}_github.json`
+
+```json
+[
+  {
+    "title": "US-001: User can register with email and password",
+    "body": "## User Story\n\nAs a **visitor**, I want to **register with my email and password**, so that **I can access my personal account**.\n\n---\n\n## Acceptance Criteria\n\n**Scenario 1 — Successful registration**\n- Given I am on the registration page\n- When I submit a valid email and password\n- Then my account is created and I am redirected to the dashboard\n\n**Scenario 2 — Duplicate email**\n- Given I submit an email that already exists\n- When the form is submitted\n- Then I see an error message 'Email already in use'\n\n---\n\n**FR Reference:** FR-001\n**Priority:** Must\n**Estimate:** 3 SP",
+    "labels": ["epic:E-01", "user-story", "priority:must"],
+    "milestone": "MVP"
+  }
+]
+```
+
+**Import via `gh` CLI:**
+```bash
+cat export_{slug}_github.json | jq -c '.[]' | while read issue; do
+  title=$(echo "$issue" | jq -r '.title')
+  body=$(echo "$issue" | jq -r '.body')
+  labels=$(echo "$issue" | jq -r '.labels | join(",")')
+  gh issue create --repo owner/repo --title "$title" --body "$body" --label "$labels"
+done
+```
+
+---
+
+## Linear JSON — `export_{slug}_linear.json`
+
+```json
+{
+  "issues": [
+    {
+      "title": "US-001: User can register with email and password",
+      "description": "**As a** visitor, **I want to** register with my email and password, **so that** I can access my personal account.\n\n### Acceptance Criteria\n\n**Scenario 1 — Successful registration**\nGiven I am on the registration page, When I submit a valid email and password, Then my account is created and I am redirected to the dashboard.\n\n**Scenario 2 — Duplicate email**\nGiven I submit an email that already exists, When the form is submitted, Then I see an error message 'Email already in use'.",
+      "priority": 2,
+      "estimate": 3,
+      "labelNames": ["E-01", "user-story"],
+      "stateName": "Backlog"
+    }
+  ]
+}
+```
+
+**Priority values:** `1` = Urgent · `2` = High · `3` = Medium · `4` = Low · `0` = No priority
+
+**Import:** Use the Linear API (`POST https://api.linear.app/graphql` with `issueCreate` mutation per issue) or the Linear SDK.
+
+---
+
+## CSV — `export_{slug}_stories.csv`
+
+```
+ID,Title,Epic,Role,Action,Benefit,Priority,Estimate,FR Reference,AC Summary
+US-001,"User can register with email and password",E-01,"visitor","register with my email and password","access my personal account",Must,3 SP,FR-001,"Given valid email+password → account created; Given duplicate email → error shown"
+US-002,"User can log in with existing credentials",E-01,"registered user","log in with email and password","access my account without re-registering",Must,2 SP,FR-002,"Given valid credentials → redirected to dashboard; Given wrong password → error shown"
+```
+
+Compatible with: Jira CSV Import · Trello · Asana · Monday.com · Google Sheets

package/skills/references/templates/handoff-template.md

@@ -0,0 +1,102 @@
+# Development Handoff Package: [PROJECT_NAME]
+
+**Domain:** [DOMAIN]
+**Date:** [DATE]
+**Slug:** [SLUG]
+**Prepared by:** BA Toolkit `/handoff`
+**References:** All pipeline artifacts
+
+---
+
+## Artifact Inventory
+
+| Artifact | File | Status | Last Updated |
+|---------|------|--------|-------------|
+| Principles | `00_principles_[SLUG].md` | ✅ Complete | [DATE] |
+| Project Brief | `01_brief_[SLUG].md` | ✅ Complete | [DATE] |
+| SRS | `02_srs_[SLUG].md` | ✅ Complete | [DATE] |
+| User Stories | `03_stories_[SLUG].md` | ✅ Complete | [DATE] |
+| Use Cases | `04_usecases_[SLUG].md` | ✅ Complete | [DATE] |
+| Acceptance Criteria | `05_ac_[SLUG].md` | ✅ Complete | [DATE] |
+| NFR | `06_nfr_[SLUG].md` | ✅ Complete | [DATE] |
+| Data Dictionary | `07_datadict_[SLUG].md` | ✅ Complete | [DATE] |
+| Research / ADRs | `07a_research_[SLUG].md` | ✅ Complete | [DATE] |
+| API Contract | `08_apicontract_[SLUG].md` | ✅ Complete | [DATE] |
+| Wireframes | `09_wireframes_[SLUG].md` | ✅ Complete | [DATE] |
+| Validation Scenarios | `10_scenarios_[SLUG].md` | ✅ Complete | [DATE] |
+
+---
+
+## MVP Scope
+
+**In scope for MVP:**
+
+| ID | Title | Type | Priority |
+|----|-------|------|---------|
+| FR-[NNN] | [Title] | Functional | Must |
+| US-[NNN] | [Story title] | Story | Must |
+
+**Explicitly out of scope (deferred to v2):**
+
+| ID | Title | Reason |
+|----|-------|--------|
+| FR-[NNN] | [Title] | [Reason — e.g. "dependency on third-party integration not available at launch"] |
+
+---
+
+## Traceability Coverage
+
+| Link | Coverage | Gap |
+|------|---------|-----|
+| FR → US | [N]% | [N orphaned FRs] |
+| US → AC | [N]% | [N stories without AC] |
+| FR → API | [N]% | [N FRs without endpoint] |
+| US → WF | [N]% | [N stories without wireframe] |
+
+---
+
+## Open Items
+
+| # | Type | Description | Owner | Priority |
+|---|------|-------------|-------|---------|
+| 1 | [Decision \| Clarification \| Dependency] | [Description] | [Role] | P1 / P2 / P3 |
+
+---
+
+## Top Risks for Development
+
+| # | Risk | Probability | Impact | Mitigation |
+|---|------|-------------|--------|-----------|
+| 1 | [Risk] | High / Med / Low | High / Med / Low | [Mitigation] |
+
+---
+
+## Recommended Development Sequence
+
+1. **[Phase / Sprint 1]** — [What to build first and why]
+2. **[Phase / Sprint 2]** — [Next priority]
+3. **[Phase / Sprint 3]** — [Following priority]
+
+_Rationale: [Why this sequencing — dependencies, risk, user value.]_
+
+---
+
+## Artifact Files Reference
+
+```
+output/[SLUG]/
+├── 00_principles_[SLUG].md
+├── 00_analyze_[SLUG].md
+├── 01_brief_[SLUG].md
+├── 02_srs_[SLUG].md
+├── 03_stories_[SLUG].md
+├── 04_usecases_[SLUG].md
+├── 05_ac_[SLUG].md
+├── 06_nfr_[SLUG].md
+├── 07_datadict_[SLUG].md
+├── 07a_research_[SLUG].md
+├── 08_apicontract_[SLUG].md
+├── 09_wireframes_[SLUG].md
+├── 10_scenarios_[SLUG].md
+└── 11_handoff_[SLUG].md     ← this document
+```

package/skills/references/templates/nfr-template.md

@@ -0,0 +1,97 @@
+# Non-functional Requirements: [PROJECT_NAME]
+
+**Domain:** [DOMAIN]
+**Date:** [DATE]
+**Slug:** [SLUG]
+**References:** `02_srs_[SLUG].md`, `00_principles_[SLUG].md`
+
+---
+
+## NFR-001: Performance
+
+| Attribute | Requirement | Measurement Method |
+|-----------|------------|-------------------|
+| [Page / operation] | [Target, e.g. < 2s p95] | [Lighthouse / load test / APM] |
+
+**Rationale:** [Why this target matters for this project.]
+
+---
+
+## NFR-002: Scalability
+
+| Attribute | Requirement | Measurement Method |
+|-----------|------------|-------------------|
+| Concurrent users | [N at peak] | [Load test scenario] |
+| Data volume | [N records, N GB] | [Capacity model] |
+
+**Rationale:** [Expected growth, peak events.]
+
+---
+
+## NFR-003: Availability & Reliability
+
+| Service | SLA | Maintenance Window |
+|---------|-----|--------------------|
+| [Service name] | 99.9% | [Sun 02:00–04:00 UTC] |
+
+**RTO:** [Recovery Time Objective, e.g. < 4h]
+**RPO:** [Recovery Point Objective, e.g. < 1h]
+
+---
+
+## NFR-004: Security
+
+| Control | Requirement |
+|---------|-------------|
+| Authentication | [e.g. JWT, OAuth 2.0, MFA for admin] |
+| Authorisation | [e.g. RBAC, row-level security] |
+| Data in transit | [TLS 1.2+] |
+| Data at rest | [AES-256] |
+| [Other control] | [requirement] |
+
+**Compliance standard:** [PCI DSS / HIPAA / GDPR / none]
+
+---
+
+## NFR-005: Maintainability
+
+| Attribute | Requirement |
+|-----------|-------------|
+| Code coverage | [≥ 80% unit test coverage] |
+| Deployment | [CI/CD, zero-downtime deployments] |
+| Logging | [Structured JSON logs, retained N days] |
+| Alerting | [P1 alert → on-call within 5 min] |
+
+---
+
+## NFR-006: Usability & Accessibility
+
+| Attribute | Requirement |
+|-----------|-------------|
+| Accessibility | [WCAG 2.1 AA] |
+| Browser support | [Chrome, Safari, Firefox — latest 2 versions] |
+| Mobile | [Responsive, iOS 15+, Android 10+] |
+| Language | [EN / RU / other] |
+
+---
+
+## NFR-007: [Additional Category]
+
+| Attribute | Requirement | Measurement Method |
+|-----------|------------|-------------------|
+| [attribute] | [requirement] | [method] |
+
+<!-- Add or remove NFR sections based on project needs. Numbering: NFR-001, NFR-002, ... -->
+
+---
+
+## Priority Summary
+
+| ID | Category | Priority |
+|----|----------|---------|
+| NFR-001 | Performance | Must |
+| NFR-002 | Scalability | Should |
+| NFR-003 | Availability | Must |
+| NFR-004 | Security | Must |
+| NFR-005 | Maintainability | Should |
+| NFR-006 | Usability | Should |