@kudusov.takhir/ba-toolkit 3.10.1 → 3.10.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +46 -0
- package/COMMANDS.md +1 -1
- package/README.md +78 -14
- package/package.json +1 -1
- package/skills/analyze/SKILL.md +1 -1
- package/skills/clarify/SKILL.md +2 -2
- package/skills/estimate/SKILL.md +1 -1
- package/skills/export/SKILL.md +1 -1
- package/skills/glossary/SKILL.md +2 -2
- package/skills/handoff/SKILL.md +1 -1
- package/skills/publish/SKILL.md +3 -3
- package/skills/references/closing-message.md +2 -2
- package/skills/references/prerequisites.md +68 -3
- package/skills/references/templates/agents-template.md +2 -2
- package/skills/references/templates/handoff-template.md +1 -1
- package/skills/risk/SKILL.md +2 -2
- package/skills/sprint/SKILL.md +1 -1
- package/skills/trace/SKILL.md +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -11,6 +11,49 @@ Versions follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
|
11
11
|
|
|
12
12
|
---
|
|
13
13
|
|
|
14
|
+
## [3.10.4] — 2026-04-11
|
|
15
|
+
|
|
16
|
+
### Changed
|
|
17
|
+
|
|
18
|
+
- **Glossary links added to README, USAGE.md, and COMMANDS.md.** Abbreviation chains (`FR → US → UC → AC → ...`) now include a parenthetical link to the glossary so first-time readers can look up unfamiliar acronyms without leaving the page.
|
|
19
|
+
- **Website sidebar reordered.** "Example project" and "Glossary" now appear immediately after "Getting started" — before the Documentation group — so new users find them early.
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## [3.10.3] — 2026-04-11
|
|
24
|
+
|
|
25
|
+
### Added
|
|
26
|
+
|
|
27
|
+
- **`docs/GLOSSARY.md`** — plain-English glossary covering core concepts (artifact, slug, pipeline, skill, domain, traceability, subcommands), requirement types (FR, US, UC, AC, NFR, SRS, ADR, DAG), and standards (IEEE 830, MoSCoW, BABOK, INVEST, Cockburn, ISO 25010, ISO 31000, PMBOK 7, Michael Nygard ADR format). Synced to the documentation website.
|
|
28
|
+
- **Prerequisites section in getting-started.md** — explains what Node.js is, how to check/install it, what npm/npx is, and what AI agents are with links to Claude Code, Cursor, Codex, Gemini, and Windsurf.
|
|
29
|
+
- **Pipeline diagram in README** — ASCII visual showing the full pipeline flow, optional steps, utility skills sidebar, and lean vs full path distinction.
|
|
30
|
+
- **8 new troubleshooting entries** for first-time users — `/brief` not responding, skill not found, `npx` not found, init fails on Windows, agent timeout, AGENTS.md not found, empty artifacts.
|
|
31
|
+
- **Example project page on the website** — Lumen Goods artifact inventory with GitHub links and "What to look for" callouts (cross-references, traceability, domain-specific content, terminology consistency).
|
|
32
|
+
- **"How to choose your domain" section in DOMAINS.md** — decision table mapping project types to the 13 available domains.
|
|
33
|
+
- **4 beginner FAQ entries** — "Can I use BA Toolkit without technical skills?", "What happens if I skip a pipeline step?", "What if the AI generates something wrong?", "How long does the full pipeline take?"
|
|
34
|
+
|
|
35
|
+
### Changed
|
|
36
|
+
|
|
37
|
+
- **README opening rewritten.** Tagline and "What is this" section now lead with a value proposition accessible to both technical and non-technical users. Pointers to getting started guide, example project, and glossary added.
|
|
38
|
+
- **Website landing page simplified.** New tagline, "Industry-standard rigour" card no longer lists raw standard names, "How it works" uses plain English instead of abbreviation chains, new "What does the output look like?" link card added.
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## [3.10.2] — 2026-04-11
|
|
43
|
+
|
|
44
|
+
### Changed
|
|
45
|
+
|
|
46
|
+
- **Standardized "Utility skills" terminology across the project.** All 9 utility skills (`/trace`, `/clarify`, `/analyze`, `/estimate`, `/glossary`, `/risk`, `/sprint`, `/export`, `/publish`) now consistently use "Utility skill" as their opener and description label. Previously the codebase mixed "Cross-cutting command", "Cross-cutting utility", "Utility command", and "Cross-cutting Tools" — now unified under a single term that pairs naturally with "Pipeline skills". Updated in 9 SKILL.md files, `closing-message.md`, `agents-template.md`, `handoff-template.md`, `handoff/SKILL.md`, `publish/SKILL.md`, and `prerequisites.md`.
|
|
47
|
+
- **README pipeline table split into two sections.** The single 24-row table is now two: a "Pipeline" table (15 numbered steps) and a "Utility skills" table (9 unnumbered skills) with an explanatory paragraph between them.
|
|
48
|
+
|
|
49
|
+
### Added
|
|
50
|
+
|
|
51
|
+
- **USAGE.md § 9 "Utility skills"** — new section with a mental-model paragraph, a quick-reference table (skill / purpose / when to use), a "When to use which" decision tree, and a note explaining how `/analyze` relates to `/clarify`, `/trace`, and `/glossary`.
|
|
52
|
+
- **FAQ: 2 new entries** — "What is the difference between pipeline skills and utility skills?" and "When should I use /analyze vs /clarify vs /trace vs /glossary?"
|
|
53
|
+
- **prerequisites.md: 6 new utility skill sections** — `/estimate`, `/glossary`, `/risk`, `/sprint`, `/export`, `/publish`. Previously only `/trace`, `/clarify`, and `/analyze` had prerequisite entries; now all 9 utility skills are covered. Existing entries relabeled from "(Cross-cutting)" to "(Utility)".
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
14
57
|
## [3.10.1] — 2026-04-10
|
|
15
58
|
|
|
16
59
|
### Fixed
|
|
@@ -742,6 +785,9 @@ CI scripts that relied on the old behaviour (`init` creates files only, `install
|
|
|
742
785
|
---
|
|
743
786
|
|
|
744
787
|
[Unreleased]: https://github.com/TakhirKudusov/ba-toolkit/compare/v3.10.1...HEAD
|
|
788
|
+
[3.10.4]: https://github.com/TakhirKudusov/ba-toolkit/compare/v3.10.3...v3.10.4
|
|
789
|
+
[3.10.3]: https://github.com/TakhirKudusov/ba-toolkit/compare/v3.10.2...v3.10.3
|
|
790
|
+
[3.10.2]: https://github.com/TakhirKudusov/ba-toolkit/compare/v3.10.1...v3.10.2
|
|
745
791
|
[3.10.1]: https://github.com/TakhirKudusov/ba-toolkit/compare/v3.10.0...v3.10.1
|
|
746
792
|
[3.10.0]: https://github.com/TakhirKudusov/ba-toolkit/compare/v3.9.0...v3.10.0
|
|
747
793
|
[3.9.0]: https://github.com/TakhirKudusov/ba-toolkit/compare/v3.8.1...v3.9.0
|
package/COMMANDS.md
CHANGED
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# 📋 BA Toolkit
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Turn a rough project idea into a complete, structured specification — then hand it to a developer or AI coding agent to build.
|
|
6
6
|
|
|
7
7
|
<img src="https://img.shields.io/badge/skills-24-blue" alt="Skills">
|
|
8
8
|
<img src="https://img.shields.io/badge/domains-12-green" alt="Domains">
|
|
@@ -22,12 +22,18 @@ Structured BA pipeline for AI coding agents — concept to a phase-and-DAG imple
|
|
|
22
22
|
|
|
23
23
|
## What is this
|
|
24
24
|
|
|
25
|
-
BA Toolkit
|
|
25
|
+
BA Toolkit turns a rough project idea into a complete, structured specification — requirements, user stories, acceptance criteria, API contracts, wireframes, and a step-by-step implementation plan. It runs as **24 AI-powered skills** inside your coding agent (Claude Code, Cursor, Codex CLI, Gemini CLI, or Windsurf) and produces Markdown documents that are cross-referenced, traceable, and ready for development or stakeholder review.
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
**How it works:** you type a slash command (e.g., `/brief`), the agent asks you a series of focused questions about your project, and generates a structured document. Each step builds on the previous ones — requirements link to user stories, stories link to acceptance criteria, and so on through the entire chain. After the last step, you have a complete specification package that a developer or AI coding agent can execute.
|
|
28
|
+
|
|
29
|
+
**For non-developer stakeholders:** `/publish` bundles every document into import-ready folders for Notion and Confluence — drag-and-drop, no API tokens, no network calls.
|
|
30
|
+
|
|
31
|
+
**Quality built in:** `/trace` verifies that every requirement is covered end-to-end. `/clarify` and `/analyze` catch ambiguities and quality gaps before they become expensive rework. Domain references for 12 industries (SaaS, Fintech, E-commerce, Healthcare, Logistics, On-demand, Social/Media, Real Estate, iGaming, EdTech, GovTech, AI/ML) add industry-specific questions and terminology automatically.
|
|
28
32
|
|
|
29
33
|
Artifacts are generated in whatever language you write in — ask in English, get English docs; ask in any other language, the output follows.
|
|
30
34
|
|
|
35
|
+
> **New to BA Toolkit?** Start with the [getting started guide](https://takhirkudusov.github.io/ba-toolkit/getting-started/) or browse a [complete example project](https://takhirkudusov.github.io/ba-toolkit/example/). For acronyms and standards referenced in the artifacts, see the [glossary](docs/GLOSSARY.md).
|
|
36
|
+
|
|
31
37
|
---
|
|
32
38
|
|
|
33
39
|
## Install
|
|
@@ -173,7 +179,7 @@ A complete example project — **Lumen Goods** (sustainable home-goods D2C onlin
|
|
|
173
179
|
| Risk Register | [`00_risks_lumen-goods.md`](example/lumen-goods/00_risks_lumen-goods.md) |
|
|
174
180
|
| Sprint Plan | [`00_sprint_lumen-goods.md`](example/lumen-goods/00_sprint_lumen-goods.md) |
|
|
175
181
|
|
|
176
|
-
Full traceability: FR → US → UC → AC → NFR → Entity → ADR → API → WF → Scenario, plus risk register and sprint plan.
|
|
182
|
+
Full traceability: FR → US → UC → AC → NFR → Entity → ADR → API → WF → Scenario, plus risk register and sprint plan. (See [glossary](docs/GLOSSARY.md) for acronym definitions.)
|
|
177
183
|
|
|
178
184
|
---
|
|
179
185
|
|
|
@@ -196,15 +202,22 @@ Full traceability: FR → US → UC → AC → NFR → Entity → ADR → API
|
|
|
196
202
|
| 10 | `/scenarios` | End-to-end Validation Scenarios — user journeys linking US, AC, WF, API | `10_scenarios_{slug}.md` |
|
|
197
203
|
| 11 | `/handoff` | Development Handoff Package — artifact inventory, MVP scope, open items | `11_handoff_{slug}.md` |
|
|
198
204
|
| 12 | `/implement-plan` | Implementation Plan for AI coding agents — phase ladder + Task DAG, every task references the FR/US/AC it implements | `12_implplan_{slug}.md` |
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
|
205
|
-
|
|
206
|
-
|
|
|
207
|
-
|
|
|
205
|
+
|
|
206
|
+
### Utility skills
|
|
207
|
+
|
|
208
|
+
Available at any pipeline stage, not tied to a fixed position. Use them to verify, estimate, publish, or export artifacts whenever needed. Start with `/analyze` for a broad quality sweep, then deep-dive with `/clarify`, `/trace`, or `/glossary` for specific concerns.
|
|
209
|
+
|
|
210
|
+
| Command | What it generates | Output file |
|
|
211
|
+
|---------|-------------------|-------------|
|
|
212
|
+
| `/trace` | Traceability Matrix + coverage gaps | `00_trace_{slug}.md` |
|
|
213
|
+
| `/clarify [focus]` | Targeted ambiguity resolution for any artifact | _(updates existing artifact)_ |
|
|
214
|
+
| `/analyze` | Cross-artifact quality report with severity table | `00_analyze_{slug}.md` |
|
|
215
|
+
| `/estimate` | Effort estimation — Fibonacci SP, T-shirt sizes, or person-days | `00_estimate_{slug}.md` |
|
|
216
|
+
| `/glossary` | Unified project glossary with terminology drift detection | `00_glossary_{slug}.md` |
|
|
217
|
+
| `/risk` | Risk register — probability × impact matrix, mitigation per risk | `00_risks_{slug}.md` |
|
|
218
|
+
| `/sprint` | Sprint plan — stories grouped by velocity and capacity with sprint goals | `00_sprint_{slug}.md` |
|
|
219
|
+
| `/export [format]` | Export User Stories to Jira / GitHub Issues / Linear / CSV | `export_{slug}_{format}.json` / `.csv` |
|
|
220
|
+
| `/publish [format]` | Bundle artifacts for Notion (Markdown) and Confluence (HTML) — drag-and-drop import, no API tokens | `publish/notion/`, `publish/confluence/` |
|
|
208
221
|
|
|
209
222
|
The project **slug** (e.g., `nova-analytics`) is set at `ba-toolkit init` (derived from the project name) and reused across all files automatically — every skill reads it from `AGENTS.md`.
|
|
210
223
|
|
|
@@ -253,11 +266,62 @@ Adding a new domain = creating one Markdown file in `skills/references/domains/`
|
|
|
253
266
|
|
|
254
267
|
---
|
|
255
268
|
|
|
269
|
+
## Pipeline at a glance
|
|
270
|
+
|
|
271
|
+
```
|
|
272
|
+
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
|
273
|
+
│ /discovery │────▶│ /brief │────▶│ /srs │────▶│ /stories │
|
|
274
|
+
│ (optional) │ │ Goals & │ │ Requirements│ │ User Stories│
|
|
275
|
+
└─────────────┘ │ Stakeholders│ │ (IEEE 830) │ │ by Epic │
|
|
276
|
+
└─────────────┘ └─────────────┘ └──────┬──────┘
|
|
277
|
+
│
|
|
278
|
+
┌───────────────────────────────────────────────────┘
|
|
279
|
+
│
|
|
280
|
+
▼
|
|
281
|
+
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
|
282
|
+
│ /usecases │────▶│ /ac │────▶│ /nfr │────▶│ /datadict │
|
|
283
|
+
│ (optional) │ │ Acceptance │ │ Performance,│ │ Entities & │
|
|
284
|
+
│ │ │ Criteria │ │ Security… │ │ Fields │
|
|
285
|
+
└─────────────┘ └─────────────┘ └─────────────┘ └──────┬──────┘
|
|
286
|
+
│
|
|
287
|
+
┌───────────────────────────────────────────────────┘
|
|
288
|
+
│
|
|
289
|
+
▼
|
|
290
|
+
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
|
291
|
+
│ /research │────▶│/apicontract │────▶│ /wireframes │────▶│ /scenarios │
|
|
292
|
+
│ (optional) │ │ Endpoints │ │ Screens │ │ (optional) │
|
|
293
|
+
│ Tech ADRs │ │ & Schemas │ │ & Navigation│ │ E2E Flows │
|
|
294
|
+
└─────────────┘ └─────────────┘ └─────────────┘ └──────┬──────┘
|
|
295
|
+
│
|
|
296
|
+
┌───────────────────────────────────────────────────┘
|
|
297
|
+
│
|
|
298
|
+
▼
|
|
299
|
+
┌─────────────┐ ┌─────────────┐
|
|
300
|
+
│ /handoff │────▶│/implement- │ ╔═══════════════════════════════╗
|
|
301
|
+
│ Dev-ready │ │ plan │ ║ UTILITY SKILLS (any stage) ║
|
|
302
|
+
│ Package │ │ Task DAG │ ║ ║
|
|
303
|
+
└─────────────┘ │ for AI Agent│ ║ /trace — coverage matrix ║
|
|
304
|
+
└─────────────┘ ║ /clarify — fix ambiguities ║
|
|
305
|
+
║ /analyze — quality report ║
|
|
306
|
+
║ /estimate — story points ║
|
|
307
|
+
║ /glossary — term consistency ║
|
|
308
|
+
║ /risk — risk register ║
|
|
309
|
+
║ /sprint — sprint plan ║
|
|
310
|
+
║ /export — Jira/GitHub/CSV ║
|
|
311
|
+
║ /publish — Notion/Confluence║
|
|
312
|
+
╚═══════════════════════════════╝
|
|
313
|
+
```
|
|
314
|
+
|
|
315
|
+
**Lean path** (~3–4 hours): skip the steps marked "(optional)" and go straight from `/brief` to `/implement-plan`.
|
|
316
|
+
**Full path** (~5–8 hours): run every step for maximum coverage and traceability.
|
|
317
|
+
|
|
318
|
+
---
|
|
319
|
+
|
|
256
320
|
## How it works
|
|
257
321
|
|
|
258
322
|
Most pipeline skills follow the same cycle: **Command → Context → Interview → Generate → Refine**. Each skill loads all previous artifacts plus the domain reference and project principles, asks a few rounds of targeted questions, writes a Markdown artifact, and offers refinement subcommands before moving on. `/handoff`, `/trace`, and `/analyze` skip the interview — they extract everything from existing artifacts automatically.
|
|
259
323
|
|
|
260
|
-
Every artifact links back to its predecessors, forming the chain `FR → US → UC → AC → NFR → Entity → ADR → API → WF → Scenario
|
|
324
|
+
Every artifact links back to its predecessors, forming the chain `FR → US → UC → AC → NFR → Entity → ADR → API → WF → Scenario` (see [glossary](docs/GLOSSARY.md) for definitions). Run `/trace` to verify coverage and `/analyze` for severity-rated findings (duplicates, ambiguous terms, terminology drift, invalid references).
|
|
261
325
|
|
|
262
326
|
### Subcommands
|
|
263
327
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kudusov.takhir/ba-toolkit",
|
|
3
|
-
"version": "3.10.
|
|
3
|
+
"version": "3.10.4",
|
|
4
4
|
"description": "AI-powered Business Analyst pipeline — 24 skills from concept discovery to a sequenced implementation plan an AI coding agent can execute, with one-command Notion + Confluence publish. Works with Claude Code, Codex CLI, Gemini CLI, Cursor, and Windsurf.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"business-analyst",
|
package/skills/analyze/SKILL.md
CHANGED
|
@@ -6,7 +6,7 @@ description: >
|
|
|
6
6
|
|
|
7
7
|
# /analyze — Cross-Artifact Quality Analysis
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Utility skill. Performs a read-only analysis across all existing pipeline artifacts and generates a structured finding report. Does not modify artifacts — use `/clarify` or `/revise` to act on findings.
|
|
10
10
|
|
|
11
11
|
## Context loading
|
|
12
12
|
|
package/skills/clarify/SKILL.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: clarify
|
|
3
3
|
description: >
|
|
4
|
-
Targeted ambiguity-resolution pass over a BA Toolkit artifact. Use on /clarify command, or when the user asks to "clarify requirements", "find ambiguities", "what is unclear", "check vague terms", "resolve ambiguities", "what needs clarification". Can be focused on a specific area: /clarify security, /clarify FR-012.
|
|
4
|
+
Targeted ambiguity-resolution pass over a BA Toolkit artifact. Use on /clarify command, or when the user asks to "clarify requirements", "find ambiguities", "what is unclear", "check vague terms", "resolve ambiguities", "what needs clarification". Can be focused on a specific area: /clarify security, /clarify FR-012. Utility skill available at any pipeline stage after the first artifact exists.
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
# /clarify — Targeted Ambiguity Resolution
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Utility skill. Performs a post-generation scan of the target artifact, surfaces specific ambiguities as questions, collects answers from the user, and updates the artifact.
|
|
10
10
|
|
|
11
11
|
## Syntax
|
|
12
12
|
|
package/skills/estimate/SKILL.md
CHANGED
|
@@ -6,7 +6,7 @@ description: >
|
|
|
6
6
|
|
|
7
7
|
# /estimate — Effort Estimation
|
|
8
8
|
|
|
9
|
-
Analyses User Stories, assigns effort estimates using the chosen scale, and produces an estimation table with rationale. Can update the stories artifact in-place or output a standalone estimation report.
|
|
9
|
+
Utility skill. Analyses User Stories, assigns effort estimates using the chosen scale, and produces an estimation table with rationale. Can update the stories artifact in-place or output a standalone estimation report.
|
|
10
10
|
|
|
11
11
|
## Syntax
|
|
12
12
|
|
package/skills/export/SKILL.md
CHANGED
|
@@ -6,7 +6,7 @@ description: >
|
|
|
6
6
|
|
|
7
7
|
# /export — Artifact Export
|
|
8
8
|
|
|
9
|
-
Converts User Stories (and optionally Acceptance Criteria) into structured output files ready for import into issue trackers and project management tools.
|
|
9
|
+
Utility skill. Converts User Stories (and optionally Acceptance Criteria) into structured output files ready for import into issue trackers and project management tools.
|
|
10
10
|
|
|
11
11
|
## Syntax
|
|
12
12
|
|
package/skills/glossary/SKILL.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: glossary
|
|
3
3
|
description: >
|
|
4
|
-
Unified project glossary extraction and maintenance for BA Toolkit projects. Use on /glossary command, or when the user asks to "build a glossary", "extract terms", "create a glossary", "consolidate terminology", "find terminology drift", "what terms are defined".
|
|
4
|
+
Unified project glossary extraction and maintenance for BA Toolkit projects. Use on /glossary command, or when the user asks to "build a glossary", "extract terms", "create a glossary", "consolidate terminology", "find terminology drift", "what terms are defined". Utility skill — can run at any pipeline stage once at least one artifact exists.
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
# /glossary — Unified Project Glossary
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Utility skill. Scans all existing artifacts and the domain reference file, extracts defined and used terms, detects terminology drift (same concept, different names), and produces or updates a single `00_glossary_{slug}.md` file.
|
|
10
10
|
|
|
11
11
|
## Syntax
|
|
12
12
|
|
package/skills/handoff/SKILL.md
CHANGED
|
@@ -59,7 +59,7 @@ No interview. All content is derived from the existing artifacts. The full templ
|
|
|
59
59
|
| 11 | Handoff | `11_handoff_{slug}.md` | This document | — |
|
|
60
60
|
| 12 | Implementation Plan | `12_implplan_{slug}.md` | ✓ / ✗ Missing / — Not run | {n} phases, {n} tasks |
|
|
61
61
|
|
|
62
|
-
###
|
|
62
|
+
### Utility artifacts
|
|
63
63
|
|
|
64
64
|
| Tool | File | Status | Key numbers |
|
|
65
65
|
|------|------|--------|-------------|
|
package/skills/publish/SKILL.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: publish
|
|
3
3
|
description: >
|
|
4
|
-
Bundle BA Toolkit artifacts into import-ready files for documentation tools — Notion (markdown bundle) and Confluence (HTML bundle). Use on /publish command, or when the user asks to "export to Notion", "export to Confluence", "publish artifacts", "share with stakeholders", "import into Notion", "import into Confluence", "send the docs to product team".
|
|
4
|
+
Bundle BA Toolkit artifacts into import-ready files for documentation tools — Notion (markdown bundle) and Confluence (HTML bundle). Use on /publish command, or when the user asks to "export to Notion", "export to Confluence", "publish artifacts", "share with stakeholders", "import into Notion", "import into Confluence", "send the docs to product team". Utility skill — does not advance the pipeline.
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
# /publish — Notion / Confluence Publish
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Utility skill. Wraps the `ba-toolkit publish` CLI subcommand, which converts the markdown artifacts in the current `output/<slug>/` folder into folders ready to be dragged into Notion's **Import → Markdown & CSV** dialog or zipped and uploaded via Confluence's **Space settings → Content tools → Import → HTML** tool.
|
|
10
10
|
|
|
11
11
|
The conversion happens entirely on disk — **no API calls, no tokens, no network**. The user does the actual upload manually using each tool's native importer.
|
|
12
12
|
|
|
@@ -62,7 +62,7 @@ Capture stdout from the command and report it back to the user. The CLI prints a
|
|
|
62
62
|
|
|
63
63
|
### 5. Closing message
|
|
64
64
|
|
|
65
|
-
|
|
65
|
+
Utility skill closing block (no `Next step:` line — see `references/closing-message.md` "Utility skills" section). Show:
|
|
66
66
|
|
|
67
67
|
- Saved bundle paths and counts per format (taken verbatim from the CLI's stdout summary).
|
|
68
68
|
- The two static "Next steps" lines:
|
|
@@ -59,7 +59,7 @@ Skills use this table as the single source of truth for the `Next step:` block.
|
|
|
59
59
|
| /handoff | /implement-plan | Sequenced implementation plan for AI coding agents | 10–20 min | (pipeline complete — hand to Claude Code / Cursor) |
|
|
60
60
|
| /implement-plan | (none) | Pipeline complete | — | Hand 12_implplan_<slug>.md to your AI coding agent |
|
|
61
61
|
|
|
62
|
-
##
|
|
62
|
+
## Utility skills (no Next step line)
|
|
63
63
|
|
|
64
64
|
These skills do not advance the pipeline — they update or report on existing artifacts. Their closing block omits the `Next step:` block entirely (omit it cleanly — don't write "Next step: none"):
|
|
65
65
|
|
|
@@ -79,7 +79,7 @@ Their closing block ends after the "Available commands" table. Optionally, they
|
|
|
79
79
|
|
|
80
80
|
- `{file_path}` is the full path where the artifact was saved (typically `output/<slug>/{NN}_{name}_{slug}.md`).
|
|
81
81
|
- The summary line is generated dynamically — do not repeat boilerplate; mention actual numbers and decisions ("18 FRs across 3 roles, 4 risks captured", not "the artifact was generated").
|
|
82
|
-
- The "Available commands" table is fixed (5 rows for pipeline skills).
|
|
82
|
+
- The "Available commands" table is fixed (5 rows for pipeline skills). Utility skills omit `/done` from the table since they don't have a "finalize" state.
|
|
83
83
|
- The "Next step" block is built from the lookup table above. Do not hardcode it in individual SKILL.md files.
|
|
84
84
|
- The "If you're stuck" section is a 2–3-line nudge for users who don't know what to do next. Keep it short.
|
|
85
85
|
- The block is a chat message, not part of the saved Markdown file.
|
|
@@ -148,7 +148,7 @@ Prerequisites marked **Required** block execution — the skill should prompt th
|
|
|
148
148
|
|
|
149
149
|
---
|
|
150
150
|
|
|
151
|
-
## /trace (
|
|
151
|
+
## /trace (Utility)
|
|
152
152
|
|
|
153
153
|
| Prerequisite | Status | Notes |
|
|
154
154
|
|-------------|--------|-------|
|
|
@@ -158,7 +158,7 @@ Prerequisites marked **Required** block execution — the skill should prompt th
|
|
|
158
158
|
|
|
159
159
|
---
|
|
160
160
|
|
|
161
|
-
## /clarify (
|
|
161
|
+
## /clarify (Utility)
|
|
162
162
|
|
|
163
163
|
| Prerequisite | Status | Notes |
|
|
164
164
|
|-------------|--------|-------|
|
|
@@ -167,7 +167,7 @@ Prerequisites marked **Required** block execution — the skill should prompt th
|
|
|
167
167
|
|
|
168
168
|
---
|
|
169
169
|
|
|
170
|
-
## /analyze (
|
|
170
|
+
## /analyze (Utility)
|
|
171
171
|
|
|
172
172
|
| Prerequisite | Status | Notes |
|
|
173
173
|
|-------------|--------|-------|
|
|
@@ -176,6 +176,71 @@ Prerequisites marked **Required** block execution — the skill should prompt th
|
|
|
176
176
|
|
|
177
177
|
---
|
|
178
178
|
|
|
179
|
+
## /estimate (Utility)
|
|
180
|
+
|
|
181
|
+
| Prerequisite | Status | Notes |
|
|
182
|
+
|-------------|--------|-------|
|
|
183
|
+
| `03_stories_*.md` | **Required** | Primary input — stories to estimate |
|
|
184
|
+
| `05_ac_*.md` | Recommended | AC scenario count is a key complexity signal |
|
|
185
|
+
| `02_srs_*.md` | Recommended | Integration points and technical constraints affect estimates |
|
|
186
|
+
| `07a_research_*.md` | Recommended | ADR-driven complexity signals |
|
|
187
|
+
| `00_principles_*.md` | Optional | Estimation conventions |
|
|
188
|
+
|
|
189
|
+
---
|
|
190
|
+
|
|
191
|
+
## /glossary (Utility)
|
|
192
|
+
|
|
193
|
+
| Prerequisite | Status | Notes |
|
|
194
|
+
|-------------|--------|-------|
|
|
195
|
+
| At least one pipeline artifact | **Required** | Needs terms to extract |
|
|
196
|
+
| `00_principles_*.md` | Optional | Language and naming conventions |
|
|
197
|
+
|
|
198
|
+
---
|
|
199
|
+
|
|
200
|
+
## /risk (Utility)
|
|
201
|
+
|
|
202
|
+
| Prerequisite | Status | Notes |
|
|
203
|
+
|-------------|--------|-------|
|
|
204
|
+
| `01_brief_*.md` | **Required** | Primary source of risks and constraints |
|
|
205
|
+
| `02_srs_*.md` | Recommended | Assumptions, constraints, out-of-scope items |
|
|
206
|
+
| `06_nfr_*.md` | Recommended | Aggressive NFR targets signal risk |
|
|
207
|
+
| `07a_research_*.md` | Recommended | Technology risks, integration unknowns |
|
|
208
|
+
| `08_apicontract_*.md` | Recommended | Third-party API dependencies, SLA gaps |
|
|
209
|
+
| `00_principles_*.md` | Optional | |
|
|
210
|
+
|
|
211
|
+
---
|
|
212
|
+
|
|
213
|
+
## /sprint (Utility)
|
|
214
|
+
|
|
215
|
+
| Prerequisite | Status | Notes |
|
|
216
|
+
|-------------|--------|-------|
|
|
217
|
+
| `00_estimate_*.md` or inline estimates in `03_stories_*.md` | **Required** | Sprint planning needs effort estimates |
|
|
218
|
+
| `03_stories_*.md` | **Required** | Stories to assign to sprints |
|
|
219
|
+
| `00_risks_*.md` | Recommended | Risk scores elevate priority of mitigating stories |
|
|
220
|
+
| `02_srs_*.md` | Recommended | Sequencing constraints beyond explicit dependencies |
|
|
221
|
+
| `00_principles_*.md` | Optional | Team capacity defaults |
|
|
222
|
+
|
|
223
|
+
---
|
|
224
|
+
|
|
225
|
+
## /export (Utility)
|
|
226
|
+
|
|
227
|
+
| Prerequisite | Status | Notes |
|
|
228
|
+
|-------------|--------|-------|
|
|
229
|
+
| `03_stories_*.md` | **Required** | Stories to export |
|
|
230
|
+
| `05_ac_*.md` | Recommended | AC scenarios embedded in issue descriptions |
|
|
231
|
+
| `00_estimate_*.md` | Recommended | Story points included in the export if available |
|
|
232
|
+
| `00_principles_*.md` | Optional | ID conventions, language settings |
|
|
233
|
+
|
|
234
|
+
---
|
|
235
|
+
|
|
236
|
+
## /publish (Utility)
|
|
237
|
+
|
|
238
|
+
| Prerequisite | Status | Notes |
|
|
239
|
+
|-------------|--------|-------|
|
|
240
|
+
| At least one pipeline artifact (`01_brief_*.md` or later) | **Required** | Nothing to publish without artifacts |
|
|
241
|
+
|
|
242
|
+
---
|
|
243
|
+
|
|
179
244
|
## Quick reference: minimum viable pipeline
|
|
180
245
|
|
|
181
246
|
To reach a development-ready handoff with the smallest number of steps:
|
|
@@ -32,9 +32,9 @@
|
|
|
32
32
|
| 11 | /handoff | ⬜ Not started | — |
|
|
33
33
|
| 12 | /implement-plan | ⬜ Not started | — |
|
|
34
34
|
|
|
35
|
-
##
|
|
35
|
+
## Utility Skills
|
|
36
36
|
|
|
37
|
-
|
|
37
|
+
Available at any pipeline stage — no fixed position. Invoke whenever they help. See COMMANDS.md for descriptions and prerequisites.md for input requirements.
|
|
38
38
|
|
|
39
39
|
| Tool | Purpose |
|
|
40
40
|
|------|---------|
|
|
@@ -32,7 +32,7 @@
|
|
|
32
32
|
| 11 | Handoff | `11_handoff_[SLUG].md` | This document | [DATE] |
|
|
33
33
|
| 12 | Implementation Plan | `12_implplan_[SLUG].md` | ✅ Complete / — Not run | [DATE] |
|
|
34
34
|
|
|
35
|
-
###
|
|
35
|
+
### Utility artifacts
|
|
36
36
|
|
|
37
37
|
| Tool | File | Status | Last Updated |
|
|
38
38
|
|------|------|--------|--------------|
|
package/skills/risk/SKILL.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: risk
|
|
3
3
|
description: >
|
|
4
|
-
Dedicated risk register for BA Toolkit projects. Use on /risk command, or when the user asks to "identify risks", "create a risk register", "assess project risks", "list risks", "risk matrix".
|
|
4
|
+
Dedicated risk register for BA Toolkit projects. Use on /risk command, or when the user asks to "identify risks", "create a risk register", "assess project risks", "list risks", "risk matrix". Utility skill — can run at any pipeline stage once Brief or SRS exists. Re-run after Research to capture technical risks.
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
# /risk — Risk Register
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Utility skill. Extracts risks from existing artifacts, classifies them by category, scores them by probability × impact, and produces or updates `00_risks_{slug}.md` with a full risk register.
|
|
10
10
|
|
|
11
11
|
## Syntax
|
|
12
12
|
|
package/skills/sprint/SKILL.md
CHANGED
|
@@ -6,7 +6,7 @@ description: >
|
|
|
6
6
|
|
|
7
7
|
# /sprint — Sprint Plan
|
|
8
8
|
|
|
9
|
-
Utility
|
|
9
|
+
Utility skill. Reads estimated User Stories, applies team capacity and velocity constraints, groups stories into sprints by priority and risk weight, and produces `00_sprint_{slug}.md` with a complete sprint breakdown.
|
|
10
10
|
|
|
11
11
|
## Syntax
|
|
12
12
|
|
package/skills/trace/SKILL.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: trace
|
|
3
3
|
description: >
|
|
4
|
-
Build and update the traceability matrix across all BA Toolkit pipeline artifacts: FR ↔ US ↔ UC ↔ AC ↔ NFR ↔ Data Entity ↔ API Endpoint ↔ Wireframe. Use on /trace command, or when the user asks for "traceability matrix", "requirements traceability", "coverage check", "uncovered requirements", "artifact links", "check coverage", "find missing requirements", "what is not covered".
|
|
4
|
+
Build and update the traceability matrix across all BA Toolkit pipeline artifacts: FR ↔ US ↔ UC ↔ AC ↔ NFR ↔ Data Entity ↔ API Endpoint ↔ Wireframe. Use on /trace command, or when the user asks for "traceability matrix", "requirements traceability", "coverage check", "uncovered requirements", "artifact links", "check coverage", "find missing requirements", "what is not covered". Utility skill available at any stage after /stories.
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
# /trace — Traceability Matrix
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Utility skill. Available after `/stories` is complete. Builds a traceability matrix across all existing artifacts.
|
|
10
10
|
|
|
11
11
|
## Context loading
|
|
12
12
|
|