@atlashub/smartstack-cli 1.13.2 → 1.14.0

package/templates/skills/business-analyse/steps/step-06-doc-html.md

@@ -0,0 +1,261 @@
+---
+name: step-06-doc-html
+description: Documentation phase - Generate React documentation page
+model: sonnet
+prev_step: steps/step-05-handoff.md
+next_step: null
+---
+
+<objective>
+Generate React documentation page integrated into SmartStack web app.
+Create i18n translations in 4 languages (FR, EN, IT, DE).
+</objective>
+
+<context7>
+CONTEXT7 REQUIRED for React generation:
+
+```
+Use context7 with /facebook/react and /i18next/react-i18next
+to generate documentation components following SmartStack patterns
+```
+
+Libraries to reference:
+- /facebook/react - React 19 patterns
+- /i18next/react-i18next - Internationalization
+- /remix-run/react-router - React Router v7
+- /lucide-icons/lucide-react - Icons
+</context7>
+
+## EXECUTION SEQUENCE
+
+### 1. Read Current State
+
+Read `{output_dir}/00-context.md` for state variables.
+Read FRD: `{output_dir}/3-functional-specification.md`
+
+Update progress: `06-doc-html` -> "In Progress"
+
+---
+
+### 2. Load React Templates (Progressive)
+
+```
+Read: react/components.md     # ~250 lines (React components)
+Read: react/schema.md         # ~100 lines (TypeScript interfaces)
+```
+
+**NOT loaded:** Full templates-react.md (580 lines)
+**Savings:** ~230 lines (40% reduction)
+
+---
+
+### 3. Extract FRD Data
+
+Parse FRD to create structured data object:
+
+```typescript
+interface FrdData {
+  featureId: string;          // From state
+  moduleName: string;         // From state
+  applicationName: string;    // From state
+  version: string;            // "1.0"
+  useCases: UseCase[];        // From FRD section 2
+  businessRules: BusinessRule[]; // From BRD section 3
+  permissions: Permission[];  // From FRD section 6
+}
+```
+
+---
+
+### 4. Generate React Component
+
+Using `react/components.md` template, generate:
+
+**File:** `web/smartstack-web/src/pages/docs/business/{app}/{module}/FrdDocPage.tsx`
+
+Key sections:
+- Breadcrumb navigation
+- Header with feature ID and version
+- Table of contents
+- Section 1: Overview with stats
+- Section 2: Use Cases cards
+- Section 3: Business Rules table
+- Section 4: Permissions list
+- Section 5: Wireframe preview
+- Section 6: API Endpoints table
+- Footer navigation
+
+**Use Context7** for:
+- Latest React patterns
+- Proper hook usage
+- TypeScript typing
+
+---
+
+### 5. Generate i18n Translations
+
+**Create 4 language files:**
+
+| Language | File |
+|----------|------|
+| FR | `web/smartstack-web/src/i18n/locales/fr/docs-{app}-{module}.json` |
+| EN | `web/smartstack-web/src/i18n/locales/en/docs-{app}-{module}.json` |
+| IT | `web/smartstack-web/src/i18n/locales/it/docs-{app}-{module}.json` |
+| DE | `web/smartstack-web/src/i18n/locales/de/docs-{app}-{module}.json` |
+
+**Structure:**
+
+```json
+{
+  "breadcrumb": {
+    "docs": "Documentation",
+    "business": "Business"
+  },
+  "common": {
+    "tableOfContents": "Table of Contents",
+    "wireframePreview": "Wireframe Preview"
+  },
+  "sections": {
+    "overview": "Overview",
+    "useCases": "Use Cases",
+    "businessRules": "Business Rules",
+    "permissions": "Permissions",
+    "wireframes": "Wireframes",
+    "api": "API Endpoints"
+  },
+  "labels": {
+    "actor": "Actor",
+    "rule": "Rule",
+    "category": "Category",
+    "priority": "Priority"
+  },
+  "stats": {
+    "useCases": "Use Cases",
+    "businessRules": "Business Rules",
+    "permissions": "Permissions"
+  },
+  "warnings": {
+    "permissionCheck": "Permission Check Required",
+    "permissionCheckDescription": "Ensure all permissions are registered before deployment."
+  },
+  "nav": {
+    "backToApp": "Back to Application",
+    "allModules": "All Modules"
+  },
+  "apps": {
+    "{app}": {
+      "name": "{Application Name}",
+      "description": "{Application description}"
+    }
+  },
+  "modules": {
+    "{module}": {
+      "name": "{Module Name}",
+      "title": "{Module Title}",
+      "subtitle": "{Module subtitle}",
+      "overview": "{Module overview from FRD}"
+    }
+  }
+}
+```
+
+**Translation strategy:**
+- FR: Source language (from FRD)
+- EN: Translate from FR
+- IT: Translate from FR
+- DE: Translate from FR
+
+---
+
+### 6. Update Routing
+
+**Add route to App.tsx or routes config:**
+
+```tsx
+{
+  path: '/docs/business/{app}/{module}',
+  element: <{Module}FrdDocPage />,
+  handle: {
+    permission: 'docs.read' // Public or minimal permission
+  }
+}
+```
+
+---
+
+### 7. Update Index Page (if needed)
+
+If this is a new module in existing application:
+
+Update `web/smartstack-web/src/pages/docs/business/{app}/index.tsx`:
+
+```tsx
+const modules: ModuleLink[] = [
+  // ... existing modules
+  {
+    id: '{module}',
+    name: '{Module Name}',
+    description: '{Module description}',
+    features: {feature_count},
+    path: '/docs/business/{app}/{module}'
+  }
+];
+```
+
+---
+
+### 8. Save Outputs
+
+**Files created:**
+
+| File | Purpose |
+|------|---------|
+| `FrdDocPage.tsx` | React documentation component |
+| `fr/docs-{app}-{module}.json` | French translations |
+| `en/docs-{app}-{module}.json` | English translations |
+| `it/docs-{app}-{module}.json` | Italian translations |
+| `de/docs-{app}-{module}.json` | German translations |
+
+Update `00-context.md`:
+- Progress: `06-doc-html` -> "Complete"
+
+---
+
+### 9. Display Final Summary
+
+```
+DOCUMENTATION - {feature_id}
+├── Status: Complete
+├── React page: FrdDocPage.tsx
+├── i18n: 4 languages created
+├── Route: /docs/business/{app}/{module}
+└── BA WORKFLOW COMPLETE
+
+Summary:
+├── Discovery: {output_dir}/1-discovery.md
+├── BRD: {output_dir}/2-business-requirements.md
+├── FRD: {output_dir}/3-functional-specification.md
+├── Validation: {output_dir}/validation.json (APPROVED)
+├── Handoff: {output_dir}/4-development-handoff.md
+└── Documentation: web/.../FrdDocPage.tsx
+
+Next steps:
+1. Review generated documentation at /docs/business/{app}/{module}
+2. Execute /implement {feature_id} to start development
+3. Run tests after implementation
+
+Thank you for using Business Analysis skill!
+Contact: support@atlshub.ch
+```
+
+---
+
+## OUTPUT
+
+This step produces:
+- React documentation page
+- 4 i18n translation files
+- Updated routing
+- Final BA summary
+
+**BA Workflow Complete.**

package/templates/skills/business-analyse/templates/00-context.md

@@ -0,0 +1,105 @@
+# Business Analysis: {{feature_id}}
+
+**Created:** {{timestamp}}
+**Feature:** {{feature_description}}
+**Application:** business/{{application_name}}/{{module_name}}
+
+---
+
+## Configuration
+
+| Setting | Value |
+|---------|-------|
+| Auto mode | {{auto_mode}} |
+| Save mode | {{save_mode}} |
+| Economy mode | {{economy_mode}} |
+
+---
+
+## Progress
+
+| Step | Status | Started | Completed |
+|------|--------|---------|-----------|
+| 00-init | {{step_00_status}} | {{step_00_started}} | {{step_00_completed}} |
+| 01-discover | {{step_01_status}} | {{step_01_started}} | {{step_01_completed}} |
+| 02-analyse | {{step_02_status}} | {{step_02_started}} | {{step_02_completed}} |
+| 03-specify | {{step_03_status}} | {{step_03_started}} | {{step_03_completed}} |
+| 04-validate | {{step_04_status}} | {{step_04_started}} | {{step_04_completed}} |
+| 05-handoff | {{step_05_status}} | {{step_05_started}} | {{step_05_completed}} |
+| 06-doc-html | {{step_06_status}} | {{step_06_started}} | {{step_06_completed}} |
+
+---
+
+## State Variables
+
+| Variable | Value |
+|----------|-------|
+| feature_id | {{feature_id}} |
+| feature_description | {{feature_description}} |
+| application_name | {{application_name}} |
+| module_name | {{module_name}} |
+| context | business |
+| permission_base | business.{{application_name}}.{{module_name}} |
+
+---
+
+## Metrics
+
+| Metric | Value |
+|--------|-------|
+| Questionnaire categories loaded | {{categories_loaded}} |
+| Questions answered | {{questions_answered}} |
+| Open questions | {{open_questions}} |
+| Business objectives | {{obj_count}} |
+| Business rules | {{br_count}} |
+| Use cases | {{uc_count}} |
+| Functional requirements | {{fr_count}} |
+| Permissions | {{perm_count}} |
+
+---
+
+## Acceptance Criteria
+
+{{#acceptance_criteria}}
+- [ ] {{criterion}}
+{{/acceptance_criteria}}
+
+---
+
+## Validation Status
+
+| Check | Status |
+|-------|--------|
+| Discovery complete | {{discovery_status}} |
+| BRD complete | {{brd_status}} |
+| FRD complete | {{frd_status}} |
+| Validation decision | {{validation_decision}} |
+| Handoff ready | {{handoff_status}} |
+
+---
+
+## Files Generated
+
+| File | Status | Size |
+|------|--------|------|
+| 1-discovery.md | {{discovery_file_status}} | {{discovery_file_size}} |
+| 2-business-requirements.md | {{brd_file_status}} | {{brd_file_size}} |
+| 3-functional-specification.md | {{frd_file_status}} | {{frd_file_size}} |
+| validation.json | {{validation_file_status}} | {{validation_file_size}} |
+| 4-development-handoff.md | {{handoff_file_status}} | {{handoff_file_size}} |
+
+---
+
+## Notes
+
+{{notes}}
+
+---
+
+## History
+
+| Timestamp | Action | Details |
+|-----------|--------|---------|
+{{#history}}
+| {{timestamp}} | {{action}} | {{details}} |
+{{/history}}

package/templates/skills/business-analyse/templates/frd-brd.md

@@ -0,0 +1,97 @@
+# Template Business Requirements Document
+
+> **Usage:** Template for 2-business-requirements.md
+> **Loaded in:** step-02-analyse.md
+
+---
+
+```markdown
+# BRD - {FEAT-XXX} {Feature Name}
+
+> **Module:** business/{application}/{module}
+> **Version:** 1.0
+> **Based on:** 1-discovery.md v1.0
+
+## 1. Executive Summary
+
+{3-5 sentence summary of the business need and proposed solution}
+
+## 2. Business Objectives
+
+| ID | Objective | Metric | Target |
+|----|----------|--------|--------|
+| OBJ-001 | {objective} | {Measurable KPI} | {target value} |
+
+## 3. Business Rules
+
+| ID | Rule | Category | Priority |
+|----|------|----------|----------|
+| BR-001 | {Business rule description} | Validation/Calculation/Workflow | Must/Should/Could |
+| BR-002 | {Description} | {category} | {priority} |
+
+### 3.1 Critical Rules Detail
+
+#### BR-001: {Rule Name}
+
+**Statement:** {Precise rule formulation}
+
+**Conditions:**
+- IF {condition A}
+- AND {condition B}
+- THEN {result}
+- ELSE {alternative result}
+
+**Examples:**
+| Input | Expected Output |
+|--------|-----------------|
+| {example 1} | {result 1} |
+| {example 2} | {result 2} |
+
+## 4. Business Process
+
+### 4.1 Main Process
+
+```
+┌─────────────┐     ┌─────────────┐     ┌─────────────┐
+│   Step 1    │────►│   Step 2    │────►│   Step 3    │
+│  {action}   │     │  {action}   │     │  {action}   │
+└─────────────┘     └─────────────┘     └─────────────┘
+      │                   │                   │
+      ▼                   ▼                   ▼
+   {actor}            {actor}            {actor}
+```
+
+### 4.2 Alternative Flows
+
+| Trigger | Flow | Result |
+|---------|------|--------|
+| {condition} | {flow description} | {final state} |
+
+## 5. Business Data
+
+### 5.1 Main Entities
+
+| Entity | Description | Cardinality |
+|--------|-------------|-------------|
+| {Entity} | {description} | 1:N with {other entity} |
+
+### 5.2 Key Attributes (NO technical types)
+
+| Entity | Attribute | Description | Required |
+|--------|-----------|-------------|----------|
+| {Entity} | {attribute} | {business description} | Yes/No |
+
+## 6. Integrations
+
+| System | Direction | Data | Frequency |
+|--------|-----------|------|-----------|
+| {system} | Input/Output/Bidirectional | {data} | Real-time/Batch |
+
+---
+
+## Version History
+
+| Version | Date | Author | Changes |
+|---------|------|--------|---------|
+| 1.0 | {date} | BA | Initial creation |
+```

package/templates/skills/business-analyse/templates/frd-discovery.md

@@ -0,0 +1,78 @@
+# Template Discovery Document
+
+> **Usage:** Template for 1-discovery.md
+> **Loaded in:** step-01-discover.md
+
+---
+
+```markdown
+# Discovery - {FEAT-XXX} {Feature Name}
+
+> **Module:** business/{application}/{module}
+> **Version:** 1.0
+> **Date:** {YYYY-MM-DD}
+> **Author:** Business Analyst
+
+## 1. Business Context
+
+### 1.1 Need Description
+{Clear description of the business need expressed by the stakeholder}
+
+### 1.2 Current Problem
+{Current situation and its limitations}
+
+### 1.3 Expected Value
+{Measurable business benefits}
+
+## 2. Stakeholders
+
+| Role | Name/Function | Involvement | Decision Level |
+|------|--------------|-------------|-----------------|
+| Sponsor | {name} | {description} | Approver |
+| Product Owner | {name} | {description} | Decision Maker |
+| Key User | {name} | {description} | Consulted |
+
+## 3. Scope
+
+### 3.1 In Scope
+- [ ] {Included feature 1}
+- [ ] {Included feature 2}
+
+### 3.2 Out of Scope
+- {Explicit exclusion 1}
+- {Explicit exclusion 2}
+
+## 4. Open Questions
+
+| # | Question | Answer | Status |
+|---|----------|--------|--------|
+| Q1 | {Question} | {Answer or "Pending"} | ⏳/✅ |
+
+## 5. Identified Constraints
+
+| Type | Constraint | Impact |
+|------|------------|--------|
+| Technical | {constraint} | {impact} |
+| Budget | {constraint} | {impact} |
+| Schedule | {constraint} | {impact} |
+| Regulatory | {constraint} | {impact} |
+
+## 6. Dependencies
+
+| Dependency | Type | Module/System | Criticality |
+|------------|------|----------------|-----------|
+| {dep} | Internal/External | {module} | High/Medium/Low |
+
+## 7. Acceptance Criteria (Inferred)
+
+- [ ] AC-001: {criterion}
+- [ ] AC-002: {criterion}
+
+---
+
+## Version History
+
+| Version | Date | Author | Changes |
+|---------|------|--------|---------|
+| 1.0 | {date} | BA | Initial creation |
+```

package/templates/skills/business-analyse/templates/frd-handoff.md

@@ -0,0 +1,118 @@
+# Template Development Handoff
+
+> **Usage:** Template for 4-development-handoff.md
+> **Loaded in:** step-05-handoff.md
+
+---
+
+```markdown
+# Development Handoff - {FEAT-XXX} {Feature Name}
+
+> **Module:** business/{application}/{module}
+> **Version:** 1.0
+> **Validated Specs:** FRD v1.0 (validation.json)
+> **Implementation:** `/implement {FEAT-XXX}`
+
+## DEVELOPER INSTRUCTIONS
+
+This document is a self-contained prompt for Claude Code. Execute:
+```
+/implement {FEAT-XXX}
+```
+
+---
+
+## 1. QUICK CONTEXT
+
+| Attribute | Value |
+|----------|--------|
+| Feature ID | {FEAT-XXX} |
+| Module | business/{application}/{module} |
+| Base Permission | `business.{app}.{module}` |
+| Complexity | {Simple/Medium/Complex} |
+
+## 2. [EXPLORE] EXISTING PATTERNS
+
+BEFORE coding, explore these files to understand the patterns:
+
+```
+BACKEND:
+- src/SmartStack.Domain/Entities/ → Entity structure
+- src/SmartStack.Application/Features/ → CQRS pattern
+- src/SmartStack.Infrastructure/Persistence/Configurations/ → EF Core
+
+FRONTEND:
+- web/smartstack-web/src/pages/business/ → Existing pages
+- web/smartstack-web/src/components/ → Reusable components
+- web/smartstack-web/src/services/api/ → API calls
+```
+
+## 3. FILES TO CREATE
+
+### 3.1 Backend
+
+| File | Template | Description |
+|------|----------|-------------|
+| `Domain/Entities/{Entity}.cs` | Domain Entity | Properties + rules |
+| `Application/Features/{Module}/` | CQRS | MediatR handlers |
+| `Infrastructure/.../Configurations/` | EF Core | Config + HasData |
+| `Api/Controllers/Business/` | Controller | REST endpoints |
+
+### 3.2 Frontend
+
+| File | Template | Description |
+|------|----------|-------------|
+| `pages/business/{app}/{module}/` | React Page | List + detail |
+| `services/api/{module}Api.ts` | API Service | Axios calls |
+| `i18n/locales/{lang}/{module}.json` | Translations | FR, EN, IT, DE |
+
+## 4. DETAILED SPECIFICATIONS
+
+### 4.1 Entity
+
+| Attribute | Description | Required | Rules |
+|-----------|-------------|----------|-------|
+| Id | Unique identifier | Yes | GUID |
+| {attr} | {description} | {Yes/No} | {validation} |
+
+### 4.2 API Endpoints
+
+| Endpoint | Method | Permission | Body | Response |
+|----------|--------|------------|------|----------|
+| `/api/business/{module}` | GET | `.read` | - | List |
+| `/api/business/{module}` | POST | `.create` | CreateDto | 201 |
+| `/api/business/{module}/{id}` | GET | `.read` | - | Entity |
+| `/api/business/{module}/{id}` | PUT | `.update` | UpdateDto | 200 |
+| `/api/business/{module}/{id}` | DELETE | `.delete` | - | 204 |
+
+### 4.3 Business Rules → Code
+
+| BR-ID | Rule | Implementation |
+|-------|------|----------------|
+| BR-001 | {rule} | {where to implement} |
+
+## 5. REQUIRED TESTS
+
+- [ ] Unit test: Entity validation
+- [ ] Integration test: API endpoints
+- [ ] Permission test: 403 denial
+- [ ] Postman test: Collection generated
+
+## 6. POST-IMPLEMENTATION CHECKLIST
+
+- [ ] Backend build OK
+- [ ] Frontend build OK
+- [ ] Tests passing
+- [ ] EF Core migration created
+- [ ] Permissions in PermissionConfiguration.cs
+- [ ] i18n complete (4 languages)
+- [ ] Documentation: `/business-analyse:6-doc-html {FEAT-XXX}`
+
+---
+
+## EXECUTION
+
+```bash
+/implement {FEAT-XXX}
+```
+```