@atlashub/smartstack-cli 2.1.0 → 2.3.0

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

@@ -1,320 +0,0 @@
----
-name: step-06-doc-html
-description: Documentation phase - Generate React documentation page
-next_step: null
----
-
-## YOUR TASK:
-
-Generate React documentation page integrated into SmartStack web app.
-Create i18n translations in 4 languages (FR, EN, IT, DE).
-
-<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"
-
-**Read digest from previous step:**
-Read `{output_dir}/digest-05.md` for compressed context from previous step.
-**DO NOT read full output files** unless in resume mode (`-r`).
-
----
-
-### 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
-
-**Step Summary:**
-
-| Field | Value |
-|-------|-------|
-| Step | DOCUMENTATION |
-| Feature | {feature_id} |
-| Status | Complete |
-| React page | FrdDocPage.tsx |
-| i18n | 4 languages created |
-| Route | /docs/business/{app}/{module} |
-| Status | BA WORKFLOW COMPLETE |
-
-**Artifacts Summary:**
-
-| Document | Location | Status |
-|----------|----------|--------|
-| Discovery | {output_dir}/1-discovery.md | Complete |
-| BRD | {output_dir}/2-business-requirements.md | Complete |
-| FRD | {output_dir}/3-functional-specification.md | Complete |
-| Validation | {output_dir}/validation.json | APPROVED |
-| Handoff | {output_dir}/4-development-handoff.md | Complete |
-| Documentation | web/.../FrdDocPage.tsx | Complete |
-
-**Next steps:**
-1. Review generated documentation at /docs/business/{app}/{module}
-2. Execute /ralph-loop -r (iterative) or /feature-full (one-shot) to start development
-3. Run tests after implementation
-
-Thank you for using Business Analysis skill!
-Contact: support@atlshub.ch
-
----
-
-### 10. Update Documentation Manifest
-
-**Update `docs-manifest.json` at project root:**
-
-1. Read existing `docs-manifest.json` (create if absent with `version: "1.0"`)
-2. Add or update the module entry:
-   ```json
-   {
-     "business/{application_name}/{module_name}": {
-       "featureId": "{feature_id}",
-       "displayName": "{module_name}",
-       "codeFiles": [/* from handoff section 3 */],
-       "docFiles": [
-         "web/.../pages/docs/business/{app}/{module}/frd-data.ts",
-         "web/.../i18n/locales/fr/docs-{app}-{module}.json"
-       ],
-       "baOutputs": ["{output_dir}"],
-       "screenshots": {/* from frd-data screenshots field */},
-       "lastCodeChange": "{current_timestamp}",
-       "lastDocUpdate": "{current_timestamp}",
-       "gitCommitCode": "",
-       "gitCommitDoc": "",
-       "status": "synced"
-     }
-   }
-   ```
-3. Update `lastUpdated` at manifest root level
-4. Write updated manifest
-
-> **Schema reference:** See `_resources/docs-manifest-schema.md` for full schema documentation.
-
----
-
-## OUTPUT FORMAT:
-
-This step produces:
-- React documentation page
-- 4 i18n translation files
-- Updated routing
-- Updated documentation manifest
-- Final BA summary
-
-**BA Workflow Complete.**
-
-## ERROR HANDLING:
-
-**If React component generation fails:**
-1. Save FRD data structure to `{output_dir}/frd-data-draft.json`
-2. Skip React page generation
-3. Mark step as "Partial - data extracted, page generation failed"
-4. Suggest: "Run `/documentation {module}` manually to retry"
-
-**If i18n translation fails for non-FR language:**
-1. Generate FR (source language) first
-2. Mark other languages as "[TODO - translation pending]"
-3. Log: "EN/IT/DE translations deferred to translation pipeline"
-
-## NEXT STEP:
-
-After completion, the Business Analysis workflow is finalized. Implementation proceeds via `/ralph-loop -r` or `/feature-full`.

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

@@ -1,105 +0,0 @@
-# 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/tpl-brd.md

@@ -1,97 +0,0 @@
-# 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/tpl-discovery.md

@@ -1,78 +0,0 @@
-# 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/tracking/change-template.md

@@ -1,30 +0,0 @@
-# Change Tracking Template
-
-## CHANGE-NNN: {description}
-
-**Feature:** {feature_id}
-**Date:** {timestamp}
-**Type:** requirement-change | scope-change | bug-fix | enhancement
-**Impact:** {modules affected}
-**Doc sync required:** Yes | No
-
-## Changes
-
-- {what changed and why}
-
-## Documentation Impact
-
-| Section | Impact | Action Required |
-|---------|--------|-----------------|
-| Business Rules | Modified BR-XXX | Update frd-data.ts |
-| Permissions | New permission added | Update frd-data.ts + PermissionConfiguration.cs |
-| API Endpoints | New endpoint | Update frd-data.ts |
-| Use Cases | Modified UC-XXX | Update frd-data.ts + i18n FR |
-
-## Validation
-
-- [ ] Code changes implemented
-- [ ] Documentation updated (frd-data.ts)
-- [ ] i18n FR updated
-- [ ] docs-manifest.json updated
-- [ ] Tests passing