kiro-spec-engine 1.3.0 → 1.4.1

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 (36) hide show
  1. package/CHANGELOG.md +85 -0
  2. package/README.md +228 -367
  3. package/README.zh.md +0 -330
  4. package/docs/README.md +223 -0
  5. package/docs/command-reference.md +252 -0
  6. package/docs/examples/add-export-command/design.md +194 -0
  7. package/docs/examples/add-export-command/requirements.md +110 -0
  8. package/docs/examples/add-export-command/tasks.md +88 -0
  9. package/docs/examples/add-rest-api/design.md +855 -0
  10. package/docs/examples/add-rest-api/requirements.md +323 -0
  11. package/docs/examples/add-rest-api/tasks.md +355 -0
  12. package/docs/examples/add-user-dashboard/design.md +192 -0
  13. package/docs/examples/add-user-dashboard/requirements.md +143 -0
  14. package/docs/examples/add-user-dashboard/tasks.md +91 -0
  15. package/docs/faq.md +696 -0
  16. package/docs/integration-modes.md +529 -0
  17. package/docs/integration-philosophy.md +313 -0
  18. package/docs/quick-start-with-ai-tools.md +374 -0
  19. package/docs/quick-start.md +711 -0
  20. package/docs/spec-workflow.md +453 -0
  21. package/docs/tools/claude-guide.md +653 -0
  22. package/docs/tools/cursor-guide.md +705 -0
  23. package/docs/tools/generic-guide.md +445 -0
  24. package/docs/tools/kiro-guide.md +308 -0
  25. package/docs/tools/vscode-guide.md +444 -0
  26. package/docs/tools/windsurf-guide.md +390 -0
  27. package/docs/troubleshooting.md +795 -0
  28. package/docs/zh/README.md +275 -0
  29. package/docs/zh/quick-start.md +711 -0
  30. package/docs/zh/tools/claude-guide.md +348 -0
  31. package/docs/zh/tools/cursor-guide.md +280 -0
  32. package/docs/zh/tools/generic-guide.md +498 -0
  33. package/docs/zh/tools/kiro-guide.md +342 -0
  34. package/docs/zh/tools/vscode-guide.md +448 -0
  35. package/docs/zh/tools/windsurf-guide.md +377 -0
  36. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -7,6 +7,91 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7
7
 
8
8
  ## [Unreleased]
9
9
 
10
+ ## [1.4.1] - 2026-01-23
11
+
12
+ ### Fixed - Documentation Clarity 🎯
13
+
14
+ **Corrected Integration Flow**:
15
+ - **Fixed sequence diagrams** - Now correctly show "User ↔ AI Tool ↔ kse" instead of "User → kse → AI Tool"
16
+ - **Emphasized AI-driven workflow** - AI tools call kse directly, users stay in their familiar interface
17
+ - **Clarified positioning** - kse works behind the scenes, users don't "switch tools"
18
+
19
+ **Updated Documentation**:
20
+ - `README.md` - Rewrote Step 4 to emphasize AI tool calls kse automatically
21
+ - `README.zh.md` - Chinese version updated to match
22
+ - `docs/integration-modes.md` - Fixed sequence diagrams and workflow descriptions
23
+
24
+ **Key Message**:
25
+ - ✅ Users continue using their preferred AI tool (Cursor, Claude, Windsurf, etc.)
26
+ - ✅ AI tool calls kse commands during conversation
27
+ - ✅ No "tool switching" - seamless integration
28
+ - ✅ kse is the "context provider" working behind the scenes
29
+
30
+ ### Why This Matters
31
+
32
+ Users are already comfortable with their AI tools. kse enhances their existing workflow by providing structured context, not by replacing their tools. This patch clarifies that positioning.
33
+
34
+ ## [1.4.0] - 2026-01-23
35
+
36
+ ### Added - User Onboarding and Documentation Overhaul 📚
37
+
38
+ **Complete Documentation Restructure**:
39
+ - **New Positioning**: Repositioned kse as "A context provider for AI coding tools"
40
+ - **Three-Tier Structure**: README → Core Guides → Tool-Specific Guides
41
+ - **"What kse is NOT" Section**: Clear clarification of kse's role
42
+
43
+ **New Documentation** (20+ new files):
44
+ - **Quick Start Guide** (`docs/quick-start.md`): Complete 5-minute tutorial with user-login example
45
+ - **6 Tool-Specific Guides**:
46
+ - Cursor Integration Guide
47
+ - Claude Code Integration Guide
48
+ - Windsurf Integration Guide
49
+ - Kiro Integration Guide
50
+ - VS Code + Copilot Integration Guide
51
+ - Generic AI Tools Guide
52
+ - **Core Guides**:
53
+ - Spec Workflow Guide (deep dive into Spec creation)
54
+ - Integration Modes Guide (Native, Manual Export, Watch Mode)
55
+ - Troubleshooting Guide (organized by category)
56
+ - FAQ (frequently asked questions)
57
+ - **3 Complete Example Specs**:
58
+ - API Feature Example (RESTful API with authentication)
59
+ - UI Feature Example (React dashboard)
60
+ - CLI Feature Example (export command)
61
+ - **Documentation Index** (`docs/README.md`): Comprehensive navigation hub
62
+
63
+ **Visual Enhancements**:
64
+ - **3 Mermaid Diagrams**:
65
+ - Spec creation workflow diagram
66
+ - Integration modes diagram
67
+ - Context flow sequence diagram
68
+
69
+ **Bilingual Support**:
70
+ - **Complete Chinese Translations**:
71
+ - Chinese README (`README.zh.md`)
72
+ - Chinese Quick Start Guide (`docs/zh/quick-start.md`)
73
+ - All 6 tool guides translated (`docs/zh/tools/`)
74
+ - Chinese documentation index (`docs/zh/README.md`)
75
+
76
+ **Metadata and Navigation**:
77
+ - Added version, date, audience, and time estimates to all major docs
78
+ - Cross-document linking with "Related Documentation" sections
79
+ - "Next Steps" sections for progressive learning
80
+ - "Getting Help" sections with multiple support channels
81
+
82
+ ### Changed
83
+
84
+ - **README.md**: Complete restructure with embedded quick start and clear positioning
85
+ - **README.zh.md**: Updated to match new English structure
86
+ - All documentation now emphasizes kse's role as a context provider for AI tools
87
+
88
+ ### Improved
89
+
90
+ - **User Experience**: Reduced time-to-first-feature from unclear to 5 minutes
91
+ - **Tool Integration**: Clear guidance for 6 major AI tools
92
+ - **Learning Path**: Progressive disclosure from beginner to advanced
93
+ - **Accessibility**: Bilingual support for English and Chinese developers
94
+
10
95
  ## [1.3.0] - 2026-01-23
11
96
 
12
97
  ### Added - Watch Mode Automation System 🤖