@kudusov.takhir/ba-toolkit 1.2.0

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.
Files changed (59) hide show
  1. package/CHANGELOG.md +125 -0
  2. package/COMMANDS.md +69 -0
  3. package/LICENSE +21 -0
  4. package/README.md +842 -0
  5. package/README.ru.md +846 -0
  6. package/bin/ba-toolkit.js +468 -0
  7. package/package.json +49 -0
  8. package/skills/ac/SKILL.md +88 -0
  9. package/skills/analyze/SKILL.md +126 -0
  10. package/skills/apicontract/SKILL.md +113 -0
  11. package/skills/brief/SKILL.md +120 -0
  12. package/skills/clarify/SKILL.md +96 -0
  13. package/skills/datadict/SKILL.md +98 -0
  14. package/skills/estimate/SKILL.md +124 -0
  15. package/skills/export/SKILL.md +215 -0
  16. package/skills/glossary/SKILL.md +145 -0
  17. package/skills/handoff/SKILL.md +146 -0
  18. package/skills/nfr/SKILL.md +85 -0
  19. package/skills/principles/SKILL.md +182 -0
  20. package/skills/references/closing-message.md +33 -0
  21. package/skills/references/domains/ecommerce.md +209 -0
  22. package/skills/references/domains/fintech.md +180 -0
  23. package/skills/references/domains/healthcare.md +223 -0
  24. package/skills/references/domains/igaming.md +183 -0
  25. package/skills/references/domains/logistics.md +221 -0
  26. package/skills/references/domains/on-demand.md +231 -0
  27. package/skills/references/domains/real-estate.md +241 -0
  28. package/skills/references/domains/saas.md +185 -0
  29. package/skills/references/domains/social-media.md +234 -0
  30. package/skills/references/environment.md +57 -0
  31. package/skills/references/prerequisites.md +191 -0
  32. package/skills/references/templates/README.md +35 -0
  33. package/skills/references/templates/ac-template.md +58 -0
  34. package/skills/references/templates/analyze-template.md +65 -0
  35. package/skills/references/templates/apicontract-template.md +183 -0
  36. package/skills/references/templates/brief-template.md +51 -0
  37. package/skills/references/templates/datadict-template.md +75 -0
  38. package/skills/references/templates/export-template.md +112 -0
  39. package/skills/references/templates/handoff-template.md +102 -0
  40. package/skills/references/templates/nfr-template.md +97 -0
  41. package/skills/references/templates/principles-template.md +118 -0
  42. package/skills/references/templates/research-template.md +99 -0
  43. package/skills/references/templates/risk-template.md +188 -0
  44. package/skills/references/templates/scenarios-template.md +93 -0
  45. package/skills/references/templates/sprint-template.md +158 -0
  46. package/skills/references/templates/srs-template.md +90 -0
  47. package/skills/references/templates/stories-template.md +60 -0
  48. package/skills/references/templates/trace-template.md +59 -0
  49. package/skills/references/templates/usecases-template.md +51 -0
  50. package/skills/references/templates/wireframes-template.md +96 -0
  51. package/skills/research/SKILL.md +136 -0
  52. package/skills/risk/SKILL.md +163 -0
  53. package/skills/scenarios/SKILL.md +113 -0
  54. package/skills/sprint/SKILL.md +174 -0
  55. package/skills/srs/SKILL.md +124 -0
  56. package/skills/stories/SKILL.md +85 -0
  57. package/skills/trace/SKILL.md +85 -0
  58. package/skills/usecases/SKILL.md +91 -0
  59. package/skills/wireframes/SKILL.md +107 -0
package/CHANGELOG.md ADDED
@@ -0,0 +1,125 @@
1
+ # Changelog
2
+
3
+ All notable changes to BA Toolkit are documented in this file.
4
+
5
+ Format follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
6
+ Versions follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ---
9
+
10
+ ## [Unreleased]
11
+
12
+ ---
13
+
14
+ ## [1.2.0] — 2026-04-08
15
+
16
+ ### Added
17
+
18
+ - `/sprint` skill — sprint planning from estimated User Stories: groups stories into sprints by velocity and capacity, applies risk-weighted prioritisation, outputs sprint goals and Definition of Done per sprint (`00_sprint_{slug}.md`).
19
+ - `skills/references/templates/sprint-template.md` — full example sprint plan for the Dragon Fortune project.
20
+ - `example/dragon-fortune/` — complete example project with all 15 pipeline artifacts for an iGaming Telegram Mini App. Fully cross-referenced: FR → US → UC → AC → NFR → Entity → ADR → API → WF → Scenario + Risk Register + Sprint Plan.
21
+ - `README.ru.md` — full Russian translation of `README.md`. Language switcher added to both versions (🇺🇸 English / 🇷🇺 Русский). EN remains the source of truth per sync rule.
22
+ - **npm package** — BA Toolkit is now publishable to npm as `ba-toolkit`. Two commands supported:
23
+ - `npx ba-toolkit init` — interactive project initialiser (creates `output/{slug}/` and `AGENTS.md`).
24
+ - `npx ba-toolkit install --for <agent>` — copies skills to the correct path for Claude Code, Codex CLI, Gemini CLI, Cursor, or Windsurf. Supports `--global`, `--project`, and `--dry-run` flags.
25
+ - Cursor and Windsurf installs auto-convert `SKILL.md` → `.mdc` rule format.
26
+ - Zero runtime dependencies; Node.js ≥ 18.
27
+ - `bin/ba-toolkit.js` — CLI entry point (~450 lines, single file, no framework).
28
+ - `package.json` — npm manifest with `bin`, `files` whitelist, and repository metadata.
29
+ - `.github/workflows/release.yml` extended with a `publish-npm` job that runs on version tag push after the GitHub Release step. Uses **npm Trusted Publishing via OIDC** — no `NPM_TOKEN` secret required, publishes provenance attestations automatically. Verifies tag matches `package.json` version and runs a CLI smoke test before publishing.
30
+
31
+ ### Fixed
32
+
33
+ - README.md tagline: outdated "19 skills" → "21 skills" (matches badge and body counters).
34
+ - `release.yml` — fixed broken `awk` regex that interpreted `[` and `]` in version headings as character class metacharacters; now uses literal `index()` matching, so release notes are correctly extracted from `## [X.Y.Z]` sections.
35
+ - `CHANGELOG.md` compare links — replaced `your-username` placeholder with actual GitHub user `TakhirKudusov`.
36
+
37
+ ---
38
+
39
+ ## [1.1.0] — 2026-04-07
40
+
41
+ ### Added
42
+
43
+ **New skills**
44
+ - `/estimate` — effort estimation for User Stories: Fibonacci Story Points, T-shirt sizes, or person-days. Includes splitting recommendations for oversized stories.
45
+ - `/glossary` — unified project glossary extraction. Scans all artifacts, detects terminology drift, finds undefined terms, generates `00_glossary_{slug}.md`.
46
+ - `/export` — artifact export to external issue trackers: Jira (JSON), GitHub Issues (JSON + `gh` CLI script), Linear (JSON), and universal CSV.
47
+
48
+ **Templates**
49
+ - Added 12 new artifact templates to `skills/references/templates/`, covering all pipeline stages: `stories`, `usecases`, `ac`, `nfr`, `datadict`, `research`, `apicontract`, `wireframes`, `scenarios`, `trace`, `analyze`, `handoff`.
50
+
51
+ **Domains**
52
+ - Added 6 new domain reference files: `ecommerce`, `healthcare`, `logistics`, `on-demand`, `social-media`, `real-estate`.
53
+ - Domain count increased from 3 to 9.
54
+
55
+ **Tooling**
56
+ - `init.ps1` — PowerShell project initialiser for Windows. Creates `output/{slug}/` and `AGENTS.md` with full pipeline status table.
57
+ - `init.sh` — Bash project initialiser for macOS / Linux. Same behaviour.
58
+ - `.github/workflows/validate.yml` — GitHub Actions CI workflow. Validates artifact structure on PRs to `output/`. Checks SKILL.md frontmatter and domain reference sections.
59
+ - `.github/scripts/validate_artifacts.py` — Python validator used by the CI workflow.
60
+
61
+ ### Changed
62
+ - `skills badge` updated from 16 to 18 (estimate, glossary, export pending `.skill` packaging).
63
+ - `domains badge` updated from 3 to 9.
64
+ - `README.md`: added "Starting a new project" section to Installation, updated Repository Structure, added `estimate.skill` and `glossary.skill` to Claude.ai install list.
65
+ - `skills/references/templates/README.md`: updated template table to list all 15 templates.
66
+
67
+ ---
68
+
69
+ ## [1.0.0] — 2026-03-15
70
+
71
+ ### Added
72
+
73
+ **Core pipeline (16 skills)**
74
+ - `/principles` — project constitution: language, ID format, traceability rules, Definition of Ready, NFR baseline, quality gates, output folder structure.
75
+ - `/brief` — project brief: goals, audience, stakeholders, constraints, risks, glossary. Creates `AGENTS.md`.
76
+ - `/srs` — software requirements specification: functional requirements (FR), roles, interfaces, MoSCoW matrix. Updates `AGENTS.md`.
77
+ - `/stories` — user stories with epics, FR links, priority, and size.
78
+ - `/usecases` — use cases with main success scenario, alternative flows, exception flows.
79
+ - `/ac` — acceptance criteria in Given / When / Then format, Definition of Done checklists.
80
+ - `/nfr` — non-functional requirements: performance, scalability, availability, security, maintainability, usability.
81
+ - `/datadict` — data dictionary: entities, fields, types, constraints, relationships, enums.
82
+ - `/research` — technology research and architecture decision records (ADRs), integration map, storage decisions, compliance notes.
83
+ - `/apicontract` — API contract: endpoints (REST/GraphQL), request/response schemas, webhooks, error codes.
84
+ - `/wireframes` — textual wireframe descriptions: layout, states, interactions, design notes per screen.
85
+ - `/scenarios` — end-to-end validation scenarios with persona, steps, expected outcome, failure conditions, coverage summary.
86
+ - `/handoff` — development handoff package: artifact inventory, MVP scope, traceability coverage, risks, recommended dev sequence.
87
+ - `/trace` — cross-artifact traceability matrix: FR → US → UC → AC → NFR → Entity → ADR → API → WF → Scenario. Coverage gaps and statistics.
88
+ - `/clarify` — targeted ambiguity resolution: metrics-free adjectives, undefined terms, conflicting rules, missing fields, ambiguous actors, duplicates.
89
+ - `/analyze` — cross-artifact quality report: duplication, ambiguity, coverage gaps, terminology drift, invalid references. Severity-rated findings.
90
+
91
+ **Iterative refinement subcommands**
92
+ - `/revise [section]` — rewrite a specific section.
93
+ - `/expand [section]` — add more detail.
94
+ - `/split [element]` — split a large User Story or FR into smaller elements.
95
+ - `/validate` — completeness and consistency check.
96
+ - `/done` — finalise artifact and advance to the next pipeline step.
97
+
98
+ **Domain references (3 initial)**
99
+ - `igaming.md` — iGaming: slots, sports betting, casino lobbies, Telegram Mini Apps, promo mechanics.
100
+ - `fintech.md` — Fintech: neobanks, payment systems, crypto exchanges, investment platforms.
101
+ - `saas.md` — SaaS: B2B platforms, CRM, analytics, marketplaces, EdTech, HRTech.
102
+
103
+ **Reference files**
104
+ - `skills/references/environment.md` — platform-specific output paths and flat/subfolder modes.
105
+ - `skills/references/closing-message.md` — standardised closing message template used by all skills.
106
+ - `skills/references/prerequisites.md` — per-step prerequisite checklists for all 16 skills.
107
+ - `skills/references/templates/` — base artifact templates: `principles`, `brief`, `srs`.
108
+
109
+ **Packaged skills**
110
+ - 16 `.skill` files in the repo root for direct upload to Claude.ai.
111
+
112
+ **AGENTS.md synchronisation**
113
+ - `/brief` creates `AGENTS.md` with project context (slug, domain, constraints, pipeline stage).
114
+ - `/srs` updates `AGENTS.md` with roles and integrations.
115
+
116
+ **Project files**
117
+ - `README.md` — full documentation: pipeline diagram, platform compatibility, usage guide, FAQ, contributing guide, domain table, example artifacts, MVP paths.
118
+ - `LICENSE` — MIT license.
119
+
120
+ ---
121
+
122
+ [Unreleased]: https://github.com/TakhirKudusov/ba-toolkit/compare/v1.2.0...HEAD
123
+ [1.2.0]: https://github.com/TakhirKudusov/ba-toolkit/compare/v1.1.0...v1.2.0
124
+ [1.1.0]: https://github.com/TakhirKudusov/ba-toolkit/compare/v1.0.0...v1.1.0
125
+ [1.0.0]: https://github.com/TakhirKudusov/ba-toolkit/releases/tag/v1.0.0
package/COMMANDS.md ADDED
@@ -0,0 +1,69 @@
1
+ # BA Toolkit — Command Reference
2
+
3
+ Quick reference for all 21 skills and subcommands.
4
+
5
+ ---
6
+
7
+ ## Pipeline skills
8
+
9
+ Run these in order. Each skill reads the output of all previous steps.
10
+
11
+ | # | Command | Output file | What it generates |
12
+ |:---:|---------|-------------|-------------------|
13
+ | 0 | `/principles` | `00_principles_{slug}.md` | Project constitution: language, ID conventions, DoR, traceability rules, NFR baseline |
14
+ | 1 | `/brief` | `01_brief_{slug}.md` | Project Brief: goals, audience, stakeholders, constraints, risks. Creates `AGENTS.md` |
15
+ | 2 | `/srs` | `02_srs_{slug}.md` | Requirements Specification (IEEE 830): scope, FRs, constraints, assumptions |
16
+ | 3 | `/stories` | `03_stories_{slug}.md` | User Stories grouped by Epics, with priority and FR references |
17
+ | 4 | `/usecases` | `04_usecases_{slug}.md` | Use Cases with main, alternative, and exception flows |
18
+ | 5 | `/ac` | `05_ac_{slug}.md` | Acceptance Criteria (Given / When / Then) linked to User Stories |
19
+ | 6 | `/nfr` | `06_nfr_{slug}.md` | Non-functional Requirements with measurable metrics |
20
+ | 7 | `/datadict` | `07_datadict_{slug}.md` | Data Dictionary: entities, fields, types, constraints, relationships |
21
+ | 7a | `/research` | `07a_research_{slug}.md` | Technology Research: ADRs, integration map, data storage decisions |
22
+ | 8 | `/apicontract` | `08_apicontract_{slug}.md` | API Contract: endpoints, request/response schemas, error codes |
23
+ | 9 | `/wireframes` | `09_wireframes_{slug}.md` | Textual Wireframe Descriptions: screens, components, navigation flows |
24
+ | 10 | `/scenarios` | `10_scenarios_{slug}.md` | End-to-end Validation Scenarios linking US → AC → WF → API |
25
+ | 11 | `/handoff` | `11_handoff_{slug}.md` | Development Handoff Package: artifact inventory, MVP scope, open items |
26
+
27
+ ---
28
+
29
+ ## Utility skills
30
+
31
+ Available at any pipeline stage.
32
+
33
+ | Command | Output file | What it generates |
34
+ |---------|-------------|-------------------|
35
+ | `/trace` | `00_trace_{slug}.md` | Traceability matrix + coverage gap report (FR → US → UC → AC → NFR → API) |
36
+ | `/analyze` | `00_analyze_{slug}.md` | Cross-artifact quality report: duplicates, coverage gaps, terminology drift, invalid references |
37
+ | `/clarify [focus]` | _(updates existing artifact)_ | Targeted ambiguity resolution: surfaces vague terms, missing metrics, conflicting rules |
38
+ | `/estimate` | `00_estimate_{slug}.md` | Effort estimation for User Stories: Fibonacci SP, T-shirt sizes, or person-days |
39
+ | `/glossary` | `00_glossary_{slug}.md` | Unified project glossary: scans all artifacts, detects terminology drift, undefined terms |
40
+ | `/export [format]` | `export_{slug}_{format}.json` / `.csv` | Export User Stories to Jira, GitHub Issues, Linear, or CSV |
41
+ | `/risk` | `00_risks_{slug}.md` | Risk register: probability × impact matrix, mitigation and contingency per risk |
42
+ | `/sprint` | `00_sprint_{slug}.md` | Sprint plan: stories grouped into sprints by velocity, capacity, and risk priority |
43
+
44
+ ---
45
+
46
+ ## Subcommands
47
+
48
+ Available within any active pipeline skill (after generation, before `/done`).
49
+
50
+ | Subcommand | What it does |
51
+ |------------|-------------|
52
+ | `/revise [section]` | Rewrite a specific section with your feedback |
53
+ | `/expand [section]` | Add more detail to a section |
54
+ | `/split [element]` | Break a large element into smaller ones (e.g., split an oversized User Story) |
55
+ | `/validate` | Check completeness, consistency, and alignment with prior artifacts |
56
+ | `/done` | Finalise the current artifact and move to the next pipeline step |
57
+
58
+ ---
59
+
60
+ ## Export formats
61
+
62
+ | Format | Command | Output file |
63
+ |--------|---------|-------------|
64
+ | Jira JSON | `/export jira` | `export_{slug}_jira.json` |
65
+ | GitHub Issues JSON | `/export github` | `export_{slug}_github.json` |
66
+ | Linear JSON | `/export linear` | `export_{slug}_linear.json` |
67
+ | CSV (universal) | `/export csv` | `export_{slug}_stories.csv` |
68
+
69
+ Scope modifiers: `/export jira E-01` (one epic) · `/export github US-007,US-008` (specific stories)
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Takhir Kudusov
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.