kiro-spec-engine 1.3.0 → 1.4.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 (36) hide show
  1. package/CHANGELOG.md +61 -0
  2. package/README.md +223 -369
  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 +525 -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,67 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7
7
 
8
8
  ## [Unreleased]
9
9
 
10
+ ## [1.4.0] - 2026-01-23
11
+
12
+ ### Added - User Onboarding and Documentation Overhaul 📚
13
+
14
+ **Complete Documentation Restructure**:
15
+ - **New Positioning**: Repositioned kse as "A context provider for AI coding tools"
16
+ - **Three-Tier Structure**: README → Core Guides → Tool-Specific Guides
17
+ - **"What kse is NOT" Section**: Clear clarification of kse's role
18
+
19
+ **New Documentation** (20+ new files):
20
+ - **Quick Start Guide** (`docs/quick-start.md`): Complete 5-minute tutorial with user-login example
21
+ - **6 Tool-Specific Guides**:
22
+ - Cursor Integration Guide
23
+ - Claude Code Integration Guide
24
+ - Windsurf Integration Guide
25
+ - Kiro Integration Guide
26
+ - VS Code + Copilot Integration Guide
27
+ - Generic AI Tools Guide
28
+ - **Core Guides**:
29
+ - Spec Workflow Guide (deep dive into Spec creation)
30
+ - Integration Modes Guide (Native, Manual Export, Watch Mode)
31
+ - Troubleshooting Guide (organized by category)
32
+ - FAQ (frequently asked questions)
33
+ - **3 Complete Example Specs**:
34
+ - API Feature Example (RESTful API with authentication)
35
+ - UI Feature Example (React dashboard)
36
+ - CLI Feature Example (export command)
37
+ - **Documentation Index** (`docs/README.md`): Comprehensive navigation hub
38
+
39
+ **Visual Enhancements**:
40
+ - **3 Mermaid Diagrams**:
41
+ - Spec creation workflow diagram
42
+ - Integration modes diagram
43
+ - Context flow sequence diagram
44
+
45
+ **Bilingual Support**:
46
+ - **Complete Chinese Translations**:
47
+ - Chinese README (`README.zh.md`)
48
+ - Chinese Quick Start Guide (`docs/zh/quick-start.md`)
49
+ - All 6 tool guides translated (`docs/zh/tools/`)
50
+ - Chinese documentation index (`docs/zh/README.md`)
51
+
52
+ **Metadata and Navigation**:
53
+ - Added version, date, audience, and time estimates to all major docs
54
+ - Cross-document linking with "Related Documentation" sections
55
+ - "Next Steps" sections for progressive learning
56
+ - "Getting Help" sections with multiple support channels
57
+
58
+ ### Changed
59
+
60
+ - **README.md**: Complete restructure with embedded quick start and clear positioning
61
+ - **README.zh.md**: Updated to match new English structure
62
+ - All documentation now emphasizes kse's role as a context provider for AI tools
63
+
64
+ ### Improved
65
+
66
+ - **User Experience**: Reduced time-to-first-feature from unclear to 5 minutes
67
+ - **Tool Integration**: Clear guidance for 6 major AI tools
68
+ - **Learning Path**: Progressive disclosure from beginner to advanced
69
+ - **Accessibility**: Bilingual support for English and Chinese developers
70
+
10
71
  ## [1.3.0] - 2026-01-23
11
72
 
12
73
  ### Added - Watch Mode Automation System 🤖