@jhm1909/ag-kit 0.1.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.
- package/.agent/ARCHITECTURE.md +189 -0
- package/.agent/known-registries.json +181 -0
- package/.agent/mcp_config.json +19 -0
- package/.agent/rules/clean-code.md +107 -0
- package/.agent/rules/documents.md +177 -0
- package/.agent/rules/git-workflow.md +68 -0
- package/.agent/rules/nano-banana.md +46 -0
- package/.agent/rules/research.md +35 -0
- package/.agent/rules/skill-loading.md +100 -0
- package/.agent/rules/skill-suggestion.md +47 -0
- package/.agent/rules/testing.md +52 -0
- package/.agent/rules/workflow-advisor.md +108 -0
- package/.agent/rules/workflow-skill-convention.md +127 -0
- package/.agent/skills/ai-engineer/SKILL.md +824 -0
- package/.agent/skills/ai-engineer/references/agentic-patterns.md +329 -0
- package/.agent/skills/ai-engineer/references/evaluation.md +493 -0
- package/.agent/skills/ai-engineer/references/llm.md +490 -0
- package/.agent/skills/ai-engineer/references/rag-advanced.md +444 -0
- package/.agent/skills/ai-engineer/references/serving-optimization.md +531 -0
- package/.agent/skills/ai-engineer/vector-db/README.md +137 -0
- package/.agent/skills/app-builder/SKILL.md +75 -0
- package/.agent/skills/app-builder/agent-coordination.md +71 -0
- package/.agent/skills/app-builder/feature-building.md +53 -0
- package/.agent/skills/app-builder/project-detection.md +34 -0
- package/.agent/skills/app-builder/scaffolding.md +118 -0
- package/.agent/skills/app-builder/tech-stack.md +41 -0
- package/.agent/skills/app-builder/templates/SKILL.md +39 -0
- package/.agent/skills/app-builder/templates/astro-static/TEMPLATE.md +76 -0
- package/.agent/skills/app-builder/templates/chrome-extension/TEMPLATE.md +92 -0
- package/.agent/skills/app-builder/templates/cli-tool/TEMPLATE.md +88 -0
- package/.agent/skills/app-builder/templates/electron-desktop/TEMPLATE.md +88 -0
- package/.agent/skills/app-builder/templates/express-api/TEMPLATE.md +83 -0
- package/.agent/skills/app-builder/templates/flutter-app/TEMPLATE.md +90 -0
- package/.agent/skills/app-builder/templates/monorepo-turborepo/TEMPLATE.md +90 -0
- package/.agent/skills/app-builder/templates/nextjs-fullstack/TEMPLATE.md +122 -0
- package/.agent/skills/app-builder/templates/nextjs-saas/TEMPLATE.md +122 -0
- package/.agent/skills/app-builder/templates/nextjs-static/TEMPLATE.md +169 -0
- package/.agent/skills/app-builder/templates/nuxt-app/TEMPLATE.md +134 -0
- package/.agent/skills/app-builder/templates/python-fastapi/TEMPLATE.md +83 -0
- package/.agent/skills/app-builder/templates/react-native-app/TEMPLATE.md +119 -0
- package/.agent/skills/backend-developer/SKILL.md +763 -0
- package/.agent/skills/backend-developer/references/general-patterns.md +65 -0
- package/.agent/skills/backend-developer/references/go-echo.md +68 -0
- package/.agent/skills/backend-developer/references/go-gin.md +76 -0
- package/.agent/skills/backend-developer/references/java-springboot.md +83 -0
- package/.agent/skills/backend-developer/references/node-express.md +64 -0
- package/.agent/skills/backend-developer/references/node-nestjs.md +69 -0
- package/.agent/skills/backend-developer/references/python-django.md +67 -0
- package/.agent/skills/backend-developer/references/python-fastapi.md +80 -0
- package/.agent/skills/blockchain-engineer/SKILL.md +975 -0
- package/.agent/skills/blockchain-engineer/references/deployment.md +28 -0
- package/.agent/skills/blockchain-engineer/references/evm.md +14 -0
- package/.agent/skills/blockchain-engineer/references/mechanisms.md +32 -0
- package/.agent/skills/blockchain-engineer/references/solidity.md +32 -0
- package/.agent/skills/business-analysis/SKILL.md +85 -0
- package/.agent/skills/business-analysis/references/best-practices/diagrams.md +141 -0
- package/.agent/skills/business-analysis/references/domains/ai-agent.md +94 -0
- package/.agent/skills/business-analysis/references/domains/blockchain-dapp.md +86 -0
- package/.agent/skills/business-analysis/references/domains/ecommerce.md +77 -0
- package/.agent/skills/business-analysis/references/domains/education.md +42 -0
- package/.agent/skills/business-analysis/references/domains/fintech.md +44 -0
- package/.agent/skills/business-analysis/references/domains/fnb.md +82 -0
- package/.agent/skills/business-analysis/references/domains/healthtech.md +44 -0
- package/.agent/skills/business-analysis/references/domains/internal-tools.md +38 -0
- package/.agent/skills/business-analysis/references/domains/marketplace.md +52 -0
- package/.agent/skills/business-analysis/references/domains/saas.md +36 -0
- package/.agent/skills/business-analysis/references/workflows/collaboration.md +41 -0
- package/.agent/skills/business-analysis/scripts/verify_mermaid.py +86 -0
- package/.agent/skills/business-analysis/templates/brd.md +46 -0
- package/.agent/skills/business-analysis/templates/change-request.md +41 -0
- package/.agent/skills/business-analysis/templates/prd-functional.md +38 -0
- package/.agent/skills/business-analysis/templates/use-case.md +40 -0
- package/.agent/skills/business-analysis/templates/user-story-detailed.md +36 -0
- package/.agent/skills/code-review/SKILL.md +113 -0
- package/.agent/skills/code-review/references/code-review-reception.md +209 -0
- package/.agent/skills/code-review/references/differential_review.md +59 -0
- package/.agent/skills/code-review/references/requesting-code-review.md +105 -0
- package/.agent/skills/code-review/references/spec_compliance.md +43 -0
- package/.agent/skills/code-review/references/verification-before-completion.md +139 -0
- package/.agent/skills/context-engineering/SKILL.md +68 -0
- package/.agent/skills/context-engineering/references/context-compression.md +84 -0
- package/.agent/skills/context-engineering/references/context-degradation.md +93 -0
- package/.agent/skills/context-engineering/references/context-fundamentals.md +75 -0
- package/.agent/skills/context-engineering/references/context-optimization.md +82 -0
- package/.agent/skills/context-engineering/references/evaluation.md +89 -0
- package/.agent/skills/context-engineering/references/memory-systems.md +88 -0
- package/.agent/skills/context-engineering/references/multi-agent-patterns.md +90 -0
- package/.agent/skills/context-engineering/references/project-development.md +97 -0
- package/.agent/skills/context-engineering/references/tool-design.md +86 -0
- package/.agent/skills/debugging/SKILL.md +60 -0
- package/.agent/skills/debugging/references/defense-in-depth.md +130 -0
- package/.agent/skills/debugging/references/root-cause-tracing.md +177 -0
- package/.agent/skills/debugging/references/systematic-debugging.md +295 -0
- package/.agent/skills/debugging/references/verification-before-completion.md +142 -0
- package/.agent/skills/designer/SKILL.md +159 -0
- package/.agent/skills/designer/concepts/apple-glass.md +48 -0
- package/.agent/skills/designer/concepts/aurora-gradients.md +26 -0
- package/.agent/skills/designer/concepts/bento-grids.md +14 -0
- package/.agent/skills/designer/concepts/claymorphism.md +27 -0
- package/.agent/skills/designer/concepts/neo-brutalism.md +32 -0
- package/.agent/skills/designer/data/app-interface.csv +31 -0
- package/.agent/skills/designer/data/charts.csv +26 -0
- package/.agent/skills/designer/data/colors.csv +162 -0
- package/.agent/skills/designer/data/design.csv +1776 -0
- package/.agent/skills/designer/data/icons.csv +106 -0
- package/.agent/skills/designer/data/landing.csv +35 -0
- package/.agent/skills/designer/data/products.csv +162 -0
- package/.agent/skills/designer/data/react-performance.csv +45 -0
- package/.agent/skills/designer/data/styles.csv +85 -0
- package/.agent/skills/designer/data/typography.csv +74 -0
- package/.agent/skills/designer/data/ui-reasoning.csv +162 -0
- package/.agent/skills/designer/data/ux-guidelines.csv +100 -0
- package/.agent/skills/designer/references/accessibility.md +172 -0
- package/.agent/skills/designer/references/branding.md +88 -0
- package/.agent/skills/designer/references/color-theory.md +139 -0
- package/.agent/skills/designer/references/creation.md +118 -0
- package/.agent/skills/designer/references/design-systems.md +219 -0
- package/.agent/skills/designer/references/frontend_design_aesthetics.md +57 -0
- package/.agent/skills/designer/references/layout.md +200 -0
- package/.agent/skills/designer/references/motion.md +92 -0
- package/.agent/skills/designer/references/review.md +100 -0
- package/.agent/skills/designer/references/trends.md +209 -0
- package/.agent/skills/designer/references/typography.md +190 -0
- package/.agent/skills/designer/scripts/remove_background.py +135 -0
- package/.agent/skills/designer/scripts/ui-search/__pycache__/core.cpython-314.pyc +0 -0
- package/.agent/skills/designer/scripts/ui-search/__pycache__/design_system.cpython-314.pyc +0 -0
- package/.agent/skills/designer/scripts/ui-search/core.py +217 -0
- package/.agent/skills/designer/scripts/ui-search/design_system.py +1067 -0
- package/.agent/skills/designer/scripts/ui-search/search.py +114 -0
- package/.agent/skills/designer/templates/design-motion-spec.md +30 -0
- package/.agent/skills/devops-engineer/SKILL.md +90 -0
- package/.agent/skills/devops-engineer/docker-compose/README.md +47 -0
- package/.agent/skills/devops-engineer/references/ci-cd-pipelines.md +76 -0
- package/.agent/skills/devops-engineer/references/cloud-providers.md +57 -0
- package/.agent/skills/devops-engineer/references/codebase-normalization.md +104 -0
- package/.agent/skills/devops-engineer/references/container-orchestration.md +69 -0
- package/.agent/skills/devops-engineer/references/iac-tools.md +63 -0
- package/.agent/skills/devops-engineer/references/observability-security.md +45 -0
- package/.agent/skills/devops-engineer/references/vercel-supabase.md +17 -0
- package/.agent/skills/devops-engineer/templates/release-notes.md +8 -0
- package/.agent/skills/frontend-developer/SKILL.md +125 -0
- package/.agent/skills/frontend-developer/react-nextjs/README.md +90 -0
- package/.agent/skills/frontend-developer/references/angular.md +52 -0
- package/.agent/skills/frontend-developer/references/composition_patterns.md +60 -0
- package/.agent/skills/frontend-developer/references/core-performance.md +68 -0
- package/.agent/skills/frontend-developer/references/modern-signals.md +43 -0
- package/.agent/skills/frontend-developer/references/react_performance_rules.md +55 -0
- package/.agent/skills/frontend-developer/references/vue-nuxt.md +55 -0
- package/.agent/skills/frontend-developer/scripts/validate_compliance.py +65 -0
- package/.agent/skills/frontend-developer/threejs/README.md +89 -0
- package/.agent/skills/frontend-developer/threejs/animation.md +552 -0
- package/.agent/skills/frontend-developer/threejs/fundamentals.md +488 -0
- package/.agent/skills/frontend-developer/threejs/geometry.md +548 -0
- package/.agent/skills/frontend-developer/threejs/interaction.md +660 -0
- package/.agent/skills/frontend-developer/threejs/lighting.md +481 -0
- package/.agent/skills/frontend-developer/threejs/loaders.md +623 -0
- package/.agent/skills/frontend-developer/threejs/materials.md +520 -0
- package/.agent/skills/frontend-developer/threejs/postprocessing.md +602 -0
- package/.agent/skills/frontend-developer/threejs/router.json +181 -0
- package/.agent/skills/frontend-developer/threejs/shaders.md +642 -0
- package/.agent/skills/frontend-developer/threejs/textures.md +628 -0
- package/.agent/skills/game-development/2d-games/SKILL.md +119 -0
- package/.agent/skills/game-development/3d-games/SKILL.md +135 -0
- package/.agent/skills/game-development/SKILL.md +167 -0
- package/.agent/skills/game-development/game-art/SKILL.md +185 -0
- package/.agent/skills/game-development/game-audio/SKILL.md +190 -0
- package/.agent/skills/game-development/game-design/SKILL.md +129 -0
- package/.agent/skills/game-development/mobile-games/SKILL.md +108 -0
- package/.agent/skills/game-development/multiplayer/SKILL.md +132 -0
- package/.agent/skills/game-development/pc-games/SKILL.md +144 -0
- package/.agent/skills/game-development/vr-ar/SKILL.md +123 -0
- package/.agent/skills/game-development/web-games/SKILL.md +150 -0
- package/.agent/skills/lead-architect/SKILL.md +85 -0
- package/.agent/skills/lead-architect/references/application-architecture.md +70 -0
- package/.agent/skills/lead-architect/references/infrastructure.md +51 -0
- package/.agent/skills/lead-architect/references/process.md +42 -0
- package/.agent/skills/lead-architect/references/system-architecture.md +62 -0
- package/.agent/skills/lead-architect/references/web-fullstack.md +82 -0
- package/.agent/skills/lead-architect/templates/adr.md +62 -0
- package/.agent/skills/lead-architect/templates/rfc.md +46 -0
- package/.agent/skills/lead-architect/templates/sdd.md +62 -0
- package/.agent/skills/lead-architect/templates/technical-spec.md +61 -0
- package/.agent/skills/marketer/SKILL.md +66 -0
- package/.agent/skills/marketer/remotion-best-practices/SKILL.md +58 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/3d.md +86 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/animations.md +29 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/assets/charts-bar-chart.tsx +173 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/assets/text-animations-typewriter.tsx +100 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/assets/text-animations-word-highlight.tsx +108 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/assets.md +78 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/audio.md +172 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/calculate-metadata.md +104 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/can-decode.md +75 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/charts.md +58 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/compositions.md +146 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/display-captions.md +126 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/extract-frames.md +229 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/fonts.md +152 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/get-audio-duration.md +58 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/get-video-dimensions.md +68 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/get-video-duration.md +58 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/gifs.md +138 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/images.md +130 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/import-srt-captions.md +67 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/lottie.md +68 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/measuring-dom-nodes.md +35 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/measuring-text.md +143 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/sequencing.md +106 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/tailwind.md +11 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/text-animations.md +20 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/timing.md +179 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/transcribe-captions.md +19 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/transitions.md +122 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/trimming.md +53 -0
- package/.agent/skills/marketer/remotion-best-practices/rules/videos.md +171 -0
- package/.agent/skills/mcp-builder/SKILL.md +76 -0
- package/.agent/skills/mcp-builder/references/evaluation.md +602 -0
- package/.agent/skills/mcp-builder/references/mcp_best_practices.md +249 -0
- package/.agent/skills/mcp-builder/references/node_mcp_server.md +970 -0
- package/.agent/skills/mcp-builder/references/python_mcp_server.md +719 -0
- package/.agent/skills/mobile-developer/SKILL.md +83 -0
- package/.agent/skills/mobile-developer/api-routes/SKILL.md +389 -0
- package/.agent/skills/mobile-developer/building-ui/SKILL.md +335 -0
- package/.agent/skills/mobile-developer/building-ui/references/animations.md +220 -0
- package/.agent/skills/mobile-developer/building-ui/references/controls.md +270 -0
- package/.agent/skills/mobile-developer/building-ui/references/form-sheet.md +227 -0
- package/.agent/skills/mobile-developer/building-ui/references/gradients.md +106 -0
- package/.agent/skills/mobile-developer/building-ui/references/icons.md +213 -0
- package/.agent/skills/mobile-developer/building-ui/references/media.md +198 -0
- package/.agent/skills/mobile-developer/building-ui/references/route-structure.md +229 -0
- package/.agent/skills/mobile-developer/building-ui/references/search.md +248 -0
- package/.agent/skills/mobile-developer/building-ui/references/storage.md +121 -0
- package/.agent/skills/mobile-developer/building-ui/references/tabs.md +368 -0
- package/.agent/skills/mobile-developer/building-ui/references/visual-effects.md +197 -0
- package/.agent/skills/mobile-developer/building-ui/references/webgpu-three.md +605 -0
- package/.agent/skills/mobile-developer/cicd-workflows/SKILL.md +107 -0
- package/.agent/skills/mobile-developer/cicd-workflows/scripts/fetch.js +109 -0
- package/.agent/skills/mobile-developer/cicd-workflows/scripts/package.json +11 -0
- package/.agent/skills/mobile-developer/cicd-workflows/scripts/validate.js +84 -0
- package/.agent/skills/mobile-developer/data-fetching/SKILL.md +508 -0
- package/.agent/skills/mobile-developer/deployment/SKILL.md +207 -0
- package/.agent/skills/mobile-developer/deployment/references/app-store-metadata.md +479 -0
- package/.agent/skills/mobile-developer/deployment/references/ios-app-store.md +355 -0
- package/.agent/skills/mobile-developer/deployment/references/play-store.md +246 -0
- package/.agent/skills/mobile-developer/deployment/references/testflight.md +58 -0
- package/.agent/skills/mobile-developer/deployment/references/workflows.md +200 -0
- package/.agent/skills/mobile-developer/dev-client/SKILL.md +181 -0
- package/.agent/skills/mobile-developer/tailwind-setup/SKILL.md +501 -0
- package/.agent/skills/mobile-developer/upgrading-expo/SKILL.md +116 -0
- package/.agent/skills/mobile-developer/upgrading-expo/references/new-architecture.md +79 -0
- package/.agent/skills/mobile-developer/upgrading-expo/references/react-19.md +79 -0
- package/.agent/skills/mobile-developer/upgrading-expo/references/react-compiler.md +59 -0
- package/.agent/skills/mobile-developer/use-dom/SKILL.md +434 -0
- package/.agent/skills/modern-python/SKILL.md +122 -0
- package/.agent/skills/project-manager/SKILL.md +110 -0
- package/.agent/skills/project-manager/references/ba-collaboration.md +62 -0
- package/.agent/skills/project-manager/references/discovery_process.md +52 -0
- package/.agent/skills/project-manager/references/jobs_to_be_done.md +51 -0
- package/.agent/skills/project-manager/references/prd_development.md +52 -0
- package/.agent/skills/project-manager/references/rules-guide.md +55 -0
- package/.agent/skills/project-manager/references/skill-creation.md +98 -0
- package/.agent/skills/project-manager/references/strategic-frameworks.md +62 -0
- package/.agent/skills/project-manager/references/task-decomposition.md +194 -0
- package/.agent/skills/project-manager/references/workflows-guide.md +44 -0
- package/.agent/skills/project-manager/router.json +160 -0
- package/.agent/skills/project-manager/scripts/compare_skill.py +177 -0
- package/.agent/skills/project-manager/scripts/encoding_utils.py +36 -0
- package/.agent/skills/project-manager/scripts/init_skill.py +190 -0
- package/.agent/skills/project-manager/scripts/quick_validate.py +123 -0
- package/.agent/skills/project-manager/templates/pm-strategy-one-pager.md +6 -0
- package/.agent/skills/project-manager/templates/prd-strategic.md +38 -0
- package/.agent/skills/project-manager/templates/skill-questionnaire.md +118 -0
- package/.agent/skills/project-manager/templates/user-story-simple.md +14 -0
- package/.agent/skills/prompt-engineer/SKILL.md +319 -0
- package/.agent/skills/prompt-engineer/skill-creator/README.md +47 -0
- package/.agent/skills/qa-tester/SKILL.md +142 -0
- package/.agent/skills/qa-tester/assets/README.md +8 -0
- package/.agent/skills/qa-tester/references/accessibility_testing.md +35 -0
- package/.agent/skills/qa-tester/references/agent_browser.md +38 -0
- package/.agent/skills/qa-tester/references/automation/api_testing.md +23 -0
- package/.agent/skills/qa-tester/references/automation/best_practices.md +14 -0
- package/.agent/skills/qa-tester/references/automation/jest_vitest.md +26 -0
- package/.agent/skills/qa-tester/references/automation/playwright.md +30 -0
- package/.agent/skills/qa-tester/references/e2e_testing.md +46 -0
- package/.agent/skills/qa-tester/references/integration_testing.md +39 -0
- package/.agent/skills/qa-tester/references/performance_testing.md +44 -0
- package/.agent/skills/qa-tester/references/property_based_testing.md +44 -0
- package/.agent/skills/qa-tester/references/security_audit.md +53 -0
- package/.agent/skills/qa-tester/references/security_testing.md +30 -0
- package/.agent/skills/qa-tester/references/sharp_edges.md +49 -0
- package/.agent/skills/qa-tester/references/static_analysis.md +52 -0
- package/.agent/skills/qa-tester/references/supply_chain_audit.md +54 -0
- package/.agent/skills/qa-tester/references/test_case_standards.md +96 -0
- package/.agent/skills/qa-tester/references/test_report_template.md +32 -0
- package/.agent/skills/qa-tester/references/unit_testing.md +50 -0
- package/.agent/skills/qa-tester/references/visual_testing.md +32 -0
- package/.agent/skills/qa-tester/templates/uat-plan.md +34 -0
- package/.agent/skills/research-first/SKILL.md +118 -0
- package/.agent/skills-manifest.json +264 -0
- package/.agent/workflows/absorb.md +176 -0
- package/.agent/workflows/bootstrap.md +91 -0
- package/.agent/workflows/brainstorm.md +168 -0
- package/.agent/workflows/break-tasks.md +77 -0
- package/.agent/workflows/commit.md +349 -0
- package/.agent/workflows/custom-behavior.md +64 -0
- package/.agent/workflows/debug.md +65 -0
- package/.agent/workflows/development.md +49 -0
- package/.agent/workflows/documentation.md +221 -0
- package/.agent/workflows/gen-tests.md +53 -0
- package/.agent/workflows/guide.md +196 -0
- package/.agent/workflows/implement-feature.md +182 -0
- package/.agent/workflows/install-skill.md +193 -0
- package/.agent/workflows/qa.md +54 -0
- package/.agent/workflows/ui-ux-design.md +108 -0
- package/LICENSE +21 -0
- package/README.md +258 -0
- package/cli/index.js +345 -0
- package/cli/migrate-skills.js +113 -0
- package/cli/verify.js +291 -0
- package/package.json +49 -0
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# F&B (Food & Beverage) Domain Reference
|
|
2
|
+
|
|
3
|
+
## Core Modules
|
|
4
|
+
|
|
5
|
+
### Menu Management
|
|
6
|
+
|
|
7
|
+
- Categories, subcategories
|
|
8
|
+
- Items (name, description, images, pricing)
|
|
9
|
+
- Modifiers and add-ons (extra cheese, size options)
|
|
10
|
+
- Combo meals, set menus
|
|
11
|
+
- Seasonal/limited items
|
|
12
|
+
- Nutritional information, allergens
|
|
13
|
+
|
|
14
|
+
### Order Management
|
|
15
|
+
|
|
16
|
+
- Order types: Dine-in, Takeaway, Delivery
|
|
17
|
+
- Order lifecycle: received → preparing → ready → served/delivered
|
|
18
|
+
- Table management (for dine-in)
|
|
19
|
+
- Kitchen display system (KDS)
|
|
20
|
+
- Order modifications, special requests
|
|
21
|
+
|
|
22
|
+
### POS (Point of Sale)
|
|
23
|
+
|
|
24
|
+
- Cash register integration
|
|
25
|
+
- Payment processing (cash, card, e-wallets, QR codes)
|
|
26
|
+
- Receipt printing
|
|
27
|
+
- Split bills, tips
|
|
28
|
+
|
|
29
|
+
### Inventory & Kitchen
|
|
30
|
+
|
|
31
|
+
- Ingredient inventory
|
|
32
|
+
- Recipe management (ingredients per item)
|
|
33
|
+
- Stock alerts, low stock warnings
|
|
34
|
+
- Waste tracking
|
|
35
|
+
- Supplier management
|
|
36
|
+
|
|
37
|
+
### Delivery & Logistics
|
|
38
|
+
|
|
39
|
+
- Delivery zones, radius
|
|
40
|
+
- Delivery fees calculation
|
|
41
|
+
- Driver assignment, tracking
|
|
42
|
+
- Integration with delivery platforms (GrabFood, ShopeeFood)
|
|
43
|
+
|
|
44
|
+
## Common Features
|
|
45
|
+
|
|
46
|
+
### Customer Experience
|
|
47
|
+
|
|
48
|
+
- Mobile ordering (app, QR code)
|
|
49
|
+
- Loyalty programs, stamps, points
|
|
50
|
+
- Reservations, waitlist
|
|
51
|
+
- Customer feedback, ratings
|
|
52
|
+
|
|
53
|
+
### Multi-location
|
|
54
|
+
|
|
55
|
+
- Branch management
|
|
56
|
+
- Centralized menu with local variations
|
|
57
|
+
- Cross-location reporting
|
|
58
|
+
- Staff assignment per location
|
|
59
|
+
|
|
60
|
+
### Marketing
|
|
61
|
+
|
|
62
|
+
- Promotions, happy hours
|
|
63
|
+
- Discount codes, vouchers
|
|
64
|
+
- Push notifications
|
|
65
|
+
- Social media integration
|
|
66
|
+
|
|
67
|
+
## User Roles
|
|
68
|
+
|
|
69
|
+
- **Customer**: Order, pay, review
|
|
70
|
+
- **Cashier**: POS operations
|
|
71
|
+
- **Kitchen Staff**: View orders, update status
|
|
72
|
+
- **Manager**: Reports, inventory, staff
|
|
73
|
+
- **Admin**: Full system access
|
|
74
|
+
|
|
75
|
+
## Key Metrics
|
|
76
|
+
|
|
77
|
+
- Revenue per day/week/month
|
|
78
|
+
- Average order value (AOV)
|
|
79
|
+
- Table turnover rate
|
|
80
|
+
- Food cost percentage
|
|
81
|
+
- Customer satisfaction (NPS)
|
|
82
|
+
- Order fulfillment time
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Domain: HealthTech (Healthcare)
|
|
2
|
+
|
|
3
|
+
## 1. Core Mindset
|
|
4
|
+
|
|
5
|
+
- **Privacy First**: HIPAA (USA) / GDPR (EU) compliance is non-negotiable.
|
|
6
|
+
- **Interoperability**: Systems must talk (FHIR, HL7 standards).
|
|
7
|
+
- **Data Integrity**: Lives are at stake. Zero tolerance for data errors.
|
|
8
|
+
|
|
9
|
+
## 2. Key Terminology (Glossary)
|
|
10
|
+
|
|
11
|
+
- **PHI (Protected Health Information)**: Any data identifying a patient + health info.
|
|
12
|
+
- **HIPAA**: US law protecting PHI.
|
|
13
|
+
- **EMR/EHR**: Electronic Medical/Health Record.
|
|
14
|
+
- **FHIR (Fast Healthcare Interoperability Resources)**: Modern standard for exchanging health data.
|
|
15
|
+
- **Telemedicine**: Remote delivery of healthcare.
|
|
16
|
+
- **Triage**: Prioritizing patients based on severity.
|
|
17
|
+
|
|
18
|
+
## 3. Common Entities (Data Models)
|
|
19
|
+
|
|
20
|
+
- **Patient**: The user. `mrn` (Medical Record Number), `dob`.
|
|
21
|
+
- **Provider**: Doctor/Nurse. `npi` (National Provider Identifier), `specialty`.
|
|
22
|
+
- **Appointment**: `patient_id`, `provider_id`, `time`, `reason`.
|
|
23
|
+
- **Observation**: Vital signs (BP, Heart Rate). FHIR Resource.
|
|
24
|
+
|
|
25
|
+
## 4. Key Workflows
|
|
26
|
+
|
|
27
|
+
### A. Appointment Booking
|
|
28
|
+
|
|
29
|
+
1. **Availability Search**: Query Provider schedule.
|
|
30
|
+
2. **Booking**: Create `Appointment` (status: scheduled).
|
|
31
|
+
3. **Confirmation**: Email/SMS to Patient (No PII in subject line!).
|
|
32
|
+
|
|
33
|
+
### B. Telehealth Session
|
|
34
|
+
|
|
35
|
+
1. **Check-in**: Patient enters virtual waiting room.
|
|
36
|
+
2. **Provider Join**: Video session starts (WebRTC, HIPAA compliant encrypted).
|
|
37
|
+
3. **SOAP Note**: Provider documents Subjective, Objective, Assessment, Plan.
|
|
38
|
+
4. **Billing**: Generate claim (ICD-10 codes).
|
|
39
|
+
|
|
40
|
+
## 5. Regulatory Compliance Checklist
|
|
41
|
+
|
|
42
|
+
- [ ] **Encryption**: At rest and in transit.
|
|
43
|
+
- [ ] **Access Logs**: Who viewed what record and when? (Audit Trail).
|
|
44
|
+
- [ ] **BAA (Business Associate Agreement)**: Required for all vendors handling PHI (e.g., AWS, Twilio).
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Internal Tools & Platforms Domain
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
Internal tools are software built for internal stakeholders (employees, operations teams). Focus is on workflow efficiency and integration with existing systems.
|
|
6
|
+
|
|
7
|
+
## Key Entities
|
|
8
|
+
|
|
9
|
+
- **Employee/User**: With department, role, permissions
|
|
10
|
+
- **Workflow**: Process steps, Approvals, Escalations
|
|
11
|
+
- **Case/Ticket**: Support cases, operational tasks
|
|
12
|
+
- **Report**: Analytics, exports, dashboards
|
|
13
|
+
|
|
14
|
+
## Common Use Cases
|
|
15
|
+
|
|
16
|
+
1. **Task Management**: Create, assign, track, close tasks
|
|
17
|
+
2. **Approval Workflows**: Request → Review → Approve/Reject
|
|
18
|
+
3. **Data Entry/Validation**: Forms with business rule validation
|
|
19
|
+
4. **Reporting**: Generate reports, schedule exports
|
|
20
|
+
5. **Integration Hub**: Sync data between systems
|
|
21
|
+
|
|
22
|
+
## Key Metrics to Document
|
|
23
|
+
|
|
24
|
+
- **Time to Resolve (TTR)**: How long to complete a task
|
|
25
|
+
- **Task Completion Rate**: Success vs abandonment
|
|
26
|
+
- **Error Rate**: Mistakes requiring rework
|
|
27
|
+
- **Adoption Rate**: % of employees using the tool
|
|
28
|
+
- **Time Saved**: Efficiency gains vs manual process
|
|
29
|
+
|
|
30
|
+
## BA Considerations
|
|
31
|
+
|
|
32
|
+
- **Existing Process Mapping**: Document current state before designing
|
|
33
|
+
- **User Shadowing**: Observe real users in their environment
|
|
34
|
+
- **Edge Cases**: What happens when things go wrong
|
|
35
|
+
- **Offline Capability**: Some environments lack reliable internet
|
|
36
|
+
- **Permission Complexity**: Often complex role hierarchies
|
|
37
|
+
- **Legacy Integration**: APIs, file exports, database syncs
|
|
38
|
+
- **Training Needs**: Users may resist change
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Marketplace / Platform Domain
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
Marketplace platforms connect buyers and sellers (or service providers and consumers). BA focus is on balancing needs of multiple user types and trust mechanisms.
|
|
6
|
+
|
|
7
|
+
## Key Entities
|
|
8
|
+
|
|
9
|
+
- **Buyer**: Consumer, Shopper, Renter
|
|
10
|
+
- **Seller**: Merchant, Service Provider, Host
|
|
11
|
+
- **Listing**: Product, Service, Property
|
|
12
|
+
- **Transaction**: Order, Booking, Rental
|
|
13
|
+
- **Review**: Ratings, Feedback, Disputes
|
|
14
|
+
|
|
15
|
+
## Common Use Cases
|
|
16
|
+
|
|
17
|
+
### Seller Side
|
|
18
|
+
|
|
19
|
+
1. **Onboarding**: Register → Verify identity → Create first listing
|
|
20
|
+
2. **Listing Management**: Create, edit, deactivate listings
|
|
21
|
+
3. **Order Fulfillment**: Accept order, Ship/Deliver, Confirm completion
|
|
22
|
+
4. **Payout Management**: View earnings, Request payout, Tax documents
|
|
23
|
+
|
|
24
|
+
### Buyer Side
|
|
25
|
+
|
|
26
|
+
1. **Discovery**: Search, Filter, Compare listings
|
|
27
|
+
2. **Purchase Flow**: Add to cart → Checkout → Payment
|
|
28
|
+
3. **Communication**: Message seller, Inquire about product
|
|
29
|
+
4. **Post-Purchase**: Track order, Request refund, Leave review
|
|
30
|
+
|
|
31
|
+
### Platform Side
|
|
32
|
+
|
|
33
|
+
1. **Dispute Resolution**: Buyer vs Seller conflict handling
|
|
34
|
+
2. **Fraud Prevention**: Suspicious activity detection
|
|
35
|
+
3. **Commission/Fees**: Take rate calculation, Payment splitting
|
|
36
|
+
|
|
37
|
+
## Key Metrics to Document
|
|
38
|
+
|
|
39
|
+
- **GMV**: Gross Merchandise Value
|
|
40
|
+
- **Take Rate**: Platform commission percentage
|
|
41
|
+
- **Buyer/Seller Ratio**: Market liquidity
|
|
42
|
+
- **Repeat Transaction Rate**: Customer retention
|
|
43
|
+
- **Time to First Transaction**: Onboarding efficiency
|
|
44
|
+
|
|
45
|
+
## BA Considerations
|
|
46
|
+
|
|
47
|
+
- **Chicken-and-Egg**: Can't have buyers without sellers (and vice versa)
|
|
48
|
+
- **Trust Mechanisms**: Reviews, Verification badges, Escrow
|
|
49
|
+
- **Payment Splitting**: Platform fee, Seller payout, Tax handling
|
|
50
|
+
- **Dispute Flow**: Who wins when buyer says "not delivered"?
|
|
51
|
+
- **Fraud Patterns**: Fake reviews, Shill bidding, Payment fraud
|
|
52
|
+
- **Category-Specific Rules**: Different flows for goods vs services
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# SaaS (Software as a Service) Domain
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
SaaS products are cloud-based software solutions delivered on a subscription basis. BA focus is on user journeys, subscription management, and self-service capabilities.
|
|
6
|
+
|
|
7
|
+
## Key Entities
|
|
8
|
+
|
|
9
|
+
- **Tenant/Organization**: Multi-tenant architecture considerations
|
|
10
|
+
- **User Roles**: Admin, Member, Guest, Billing Admin
|
|
11
|
+
- **Subscription**: Plan, Billing Cycle, Usage Limits
|
|
12
|
+
- **Feature Flags**: Entitlements per plan tier
|
|
13
|
+
|
|
14
|
+
## Common Use Cases
|
|
15
|
+
|
|
16
|
+
1. **User Onboarding**: Sign up → Email verify → First-time setup wizard
|
|
17
|
+
2. **Team Management**: Invite users, Assign roles, Remove members
|
|
18
|
+
3. **Subscription Management**: Upgrade, Downgrade, Cancel, Pause
|
|
19
|
+
4. **Usage Tracking**: Quota monitoring, Overage alerts
|
|
20
|
+
5. **Self-Service Support**: Knowledge base, Ticket submission
|
|
21
|
+
|
|
22
|
+
## Key Metrics to Document
|
|
23
|
+
|
|
24
|
+
- **ARR/MRR**: Annual/Monthly Recurring Revenue
|
|
25
|
+
- **Churn Rate**: Customer attrition
|
|
26
|
+
- **LTV/CAC**: Lifetime Value vs Customer Acquisition Cost
|
|
27
|
+
- **DAU/MAU**: Daily/Monthly Active Users
|
|
28
|
+
- **NPS**: Net Promoter Score
|
|
29
|
+
|
|
30
|
+
## BA Considerations
|
|
31
|
+
|
|
32
|
+
- **Multi-tenancy**: Data isolation between customers
|
|
33
|
+
- **Plan Gating**: Which features at which tier
|
|
34
|
+
- **Trial Logic**: Time-limited trials, feature-limited trials
|
|
35
|
+
- **Billing Integration**: Stripe, Paddle, Chargebee patterns
|
|
36
|
+
- **SSO/SAML**: Enterprise authentication requirements
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Cross-Skill Collaboration Workflow
|
|
2
|
+
|
|
3
|
+
## 1. Interaction Model
|
|
4
|
+
|
|
5
|
+
The Business Analyst (BA) defines **WHAT** and **WHY**.
|
|
6
|
+
|
|
7
|
+
- The **Lead Architect** defines **HOW** (Backend/Data).
|
|
8
|
+
- The **Designer** defines **HOW** (Frontend/UX).
|
|
9
|
+
- The **Product Manager** approves **WHEN** (Scope/Roadmap).
|
|
10
|
+
|
|
11
|
+
## 2. Integration Points
|
|
12
|
+
|
|
13
|
+
### With `lead-architect`
|
|
14
|
+
|
|
15
|
+
- **Trigger**: When functional requirements need concrete technical details (Schema, API, Stack).
|
|
16
|
+
- **Prompt**:
|
|
17
|
+
> "I have defined the User Stories for [Feature]. Acting as Lead Architect, please transform this into a Technical Specification, specifically defining the DB Schema and API Endpoints."
|
|
18
|
+
- **Validation**:
|
|
19
|
+
- Does the Schema support the "Given" preconditions?
|
|
20
|
+
- Do the API error codes cover the "Negative Paths"?
|
|
21
|
+
|
|
22
|
+
### With `designer`
|
|
23
|
+
|
|
24
|
+
- **Trigger**: When requirements involve user interaction (UI).
|
|
25
|
+
- **Prompt**:
|
|
26
|
+
> "I have defined the User Flow for [Feature]. Acting as Designer, please propose a wireframe description or Component Hierarchy that meets these accessibility requirements."
|
|
27
|
+
- **Validation**:
|
|
28
|
+
- Does the design include the "Empty States" identified?
|
|
29
|
+
- Are verification steps (e.g., "Confirm Email") visible?
|
|
30
|
+
|
|
31
|
+
### With `product-manager`
|
|
32
|
+
|
|
33
|
+
- **Trigger**: When scope creep happens or priorities are unclear.
|
|
34
|
+
- **Prompt**:
|
|
35
|
+
> "We identified 5 edge cases. Acting as Product Manager, should we include these in MVP or defer to Phase 2?"
|
|
36
|
+
|
|
37
|
+
## 3. Simulation Mode
|
|
38
|
+
|
|
39
|
+
If other skills are not explicitly active in the agent session, the BA must **simulate** their persona to generate complete specs.
|
|
40
|
+
|
|
41
|
+
- _Self-Correction_: "Speaking as the Architect, that query is too expensive. Let's denormalize..."
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
import sys
|
|
2
|
+
import re
|
|
3
|
+
import subprocess
|
|
4
|
+
import shutil
|
|
5
|
+
|
|
6
|
+
def check_mermaid_cli():
|
|
7
|
+
"""Check if mmdc (Mermaid CLI) is installed."""
|
|
8
|
+
return shutil.which("mmdc") is not None
|
|
9
|
+
|
|
10
|
+
def validate_mermaid_content(content):
|
|
11
|
+
"""
|
|
12
|
+
Validates Mermaid syntax.
|
|
13
|
+
1. Basic Regex checks for common errors.
|
|
14
|
+
2. (Optional) Runs mmdc --dry-run if available.
|
|
15
|
+
"""
|
|
16
|
+
errors = []
|
|
17
|
+
|
|
18
|
+
# Check 1: Empty content
|
|
19
|
+
if not content.strip():
|
|
20
|
+
return ["Error: Diagram content is empty."]
|
|
21
|
+
|
|
22
|
+
# Check 2: Known Diagram Types
|
|
23
|
+
valid_starts = [
|
|
24
|
+
"flowchart", "graph", "sequenceDiagram", "classDiagram",
|
|
25
|
+
"stateDiagram", "erDiagram", "gantt", "pie", "journey",
|
|
26
|
+
"gitGraph", "C4Context"
|
|
27
|
+
]
|
|
28
|
+
|
|
29
|
+
first_line = content.strip().split('\n')[0].strip()
|
|
30
|
+
# Remove options like 'flowchart TD' -> 'flowchart'
|
|
31
|
+
diagram_type = first_line.split(' ')[0]
|
|
32
|
+
|
|
33
|
+
if diagram_type not in valid_starts:
|
|
34
|
+
errors.append(f"Warning: Unknown or missing diagram type '{diagram_type}'. Supported: {', '.join(valid_starts)}")
|
|
35
|
+
|
|
36
|
+
# Check 3: Brackets balance (simple check)
|
|
37
|
+
if content.count('{') != content.count('}'):
|
|
38
|
+
errors.append("Error: Mismatched curly braces '{}'.")
|
|
39
|
+
|
|
40
|
+
# Check 4: Sequence Diagram participants
|
|
41
|
+
if diagram_type == "sequenceDiagram":
|
|
42
|
+
if "participant" not in content and "->" not in content and "-->>" not in content:
|
|
43
|
+
errors.append("Warning: Sequence diagram appears to lack interactions (arrows).")
|
|
44
|
+
|
|
45
|
+
return errors
|
|
46
|
+
|
|
47
|
+
def main(filepath):
|
|
48
|
+
try:
|
|
49
|
+
with open(filepath, 'r') as f:
|
|
50
|
+
content = f.read()
|
|
51
|
+
|
|
52
|
+
print(f"Validating {filepath}...")
|
|
53
|
+
errors = validate_mermaid_content(content)
|
|
54
|
+
|
|
55
|
+
if errors:
|
|
56
|
+
print("❌ Validation Failed:")
|
|
57
|
+
for err in errors:
|
|
58
|
+
print(f" - {err}")
|
|
59
|
+
sys.exit(1)
|
|
60
|
+
else:
|
|
61
|
+
print("✅ Syntax looks plausible (regex check).")
|
|
62
|
+
|
|
63
|
+
# Optional: Real validation using CLI
|
|
64
|
+
if check_mermaid_cli():
|
|
65
|
+
print("Running mmdc (Mermaid CLI) for strict validation...")
|
|
66
|
+
try:
|
|
67
|
+
# Run a dry run or output to null
|
|
68
|
+
subprocess.run(["mmdc", "-i", filepath, "-o", "/dev/null"], check=True, capture_output=True)
|
|
69
|
+
print("✅ mmdc validation passed.")
|
|
70
|
+
except subprocess.CalledProcessError as e:
|
|
71
|
+
print("❌ mmdc validation failed:")
|
|
72
|
+
print(e.stderr.decode())
|
|
73
|
+
sys.exit(1)
|
|
74
|
+
else:
|
|
75
|
+
print("ℹ️ mmdc not found. Skipping strict CLI validation. Install @mermaid-js/mermaid-cli for better checks.")
|
|
76
|
+
|
|
77
|
+
except FileNotFoundError:
|
|
78
|
+
print(f"Error: File {filepath} not found.")
|
|
79
|
+
sys.exit(1)
|
|
80
|
+
|
|
81
|
+
if __name__ == "__main__":
|
|
82
|
+
if len(sys.argv) < 2:
|
|
83
|
+
print("Usage: python verify_mermaid.py <path_to_mermaid_file>")
|
|
84
|
+
sys.exit(1)
|
|
85
|
+
|
|
86
|
+
main(sys.argv[1])
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Business Requirements Document (BRD)
|
|
2
|
+
|
|
3
|
+
## 1. Executive Summary
|
|
4
|
+
|
|
5
|
+
- **Project Name**: ...
|
|
6
|
+
- **Sponsor**: ...
|
|
7
|
+
- **Objective**: High-level goal (e.g., "Increase conversion by 20%").
|
|
8
|
+
- **Key Driver**: Why now? (e.g., Compliance, Market opportunity).
|
|
9
|
+
|
|
10
|
+
## 2. Business Problem
|
|
11
|
+
|
|
12
|
+
- **Current State**: Description of the pain point or inefficiency.
|
|
13
|
+
- **Proposed Solution**: High-level description of the change.
|
|
14
|
+
- **Scope**:
|
|
15
|
+
- **In Scope**: ...
|
|
16
|
+
- **Out of Scope**: ...
|
|
17
|
+
|
|
18
|
+
## 3. Business Value (ROI)
|
|
19
|
+
|
|
20
|
+
- **Tangible Benefits**: Revenue increase, cost saving ($).
|
|
21
|
+
- **Intangible Benefits**: Brand reputation, user satisfaction.
|
|
22
|
+
- **Success Metrics (KPIs)**:
|
|
23
|
+
- KPI 1: ...
|
|
24
|
+
- KPI 2: ...
|
|
25
|
+
|
|
26
|
+
## 4. Stakeholder Analysis
|
|
27
|
+
|
|
28
|
+
| Stakeholder Group | Impact (High/Med/Low) | Needs/Interests |
|
|
29
|
+
| :---------------- | :-------------------- | :------------------- |
|
|
30
|
+
| Finance | High | Accurate reporting |
|
|
31
|
+
| Customer Support | Med | Training on new tool |
|
|
32
|
+
|
|
33
|
+
## 5. Market Analysis
|
|
34
|
+
|
|
35
|
+
- **Competitor Overview**: ...
|
|
36
|
+
- **Target Market**: ...
|
|
37
|
+
|
|
38
|
+
## 6. High-Level Requirements
|
|
39
|
+
|
|
40
|
+
- **BR-01**: Must support multi-currency.
|
|
41
|
+
- **BR-02**: Must integrate with SAP.
|
|
42
|
+
|
|
43
|
+
## 7. Risks & Constraints
|
|
44
|
+
|
|
45
|
+
- **Risks**: Regulatory changes, Technical debt.
|
|
46
|
+
- **Constraints**: Budget cap, Strict deadline.
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Change Request (CR)
|
|
2
|
+
|
|
3
|
+
## 1. Change Summary
|
|
4
|
+
|
|
5
|
+
- **CR ID**: CR-[YYYY]-[Number]
|
|
6
|
+
- **Date**: YYYY-MM-DD
|
|
7
|
+
- **Requestor**: [Name/Dept]
|
|
8
|
+
- **Title**: ...
|
|
9
|
+
|
|
10
|
+
## 2. Description of Change
|
|
11
|
+
|
|
12
|
+
- **Current Functionality**: ...
|
|
13
|
+
- **Requested Change**: ...
|
|
14
|
+
- **Reason/Business Justification**: Why is this needed now? What happens if we don't do it?
|
|
15
|
+
|
|
16
|
+
## 3. Impact Analysis
|
|
17
|
+
|
|
18
|
+
### Technical Impact
|
|
19
|
+
|
|
20
|
+
- **Files/Modules Affected**: ...
|
|
21
|
+
- **Complexity**: Low/Med/High
|
|
22
|
+
- **Risks**: Regression in [Feature X].
|
|
23
|
+
|
|
24
|
+
### Project Impact
|
|
25
|
+
|
|
26
|
+
- **Effort Estimate**: [Hours/Days]
|
|
27
|
+
- **Cost Impact**: [$]
|
|
28
|
+
- **Schedule Delay**: [Days]
|
|
29
|
+
|
|
30
|
+
## 4. Recommendation
|
|
31
|
+
|
|
32
|
+
- [ ] **Approve** (Proceed immediately)
|
|
33
|
+
- [ ] **Defer** (Move to Backlog/Next Phase)
|
|
34
|
+
- [ ] **Reject** (Out of scope/Not feasible)
|
|
35
|
+
|
|
36
|
+
## 5. Approval
|
|
37
|
+
|
|
38
|
+
| Role | Name | Signature | Date |
|
|
39
|
+
| :-------------- | :--- | :-------- | :--- |
|
|
40
|
+
| Project Manager | | | |
|
|
41
|
+
| Client Sponsor | | | |
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Product Requirements Document (PRD)
|
|
2
|
+
|
|
3
|
+
## 1. Introduction
|
|
4
|
+
|
|
5
|
+
- **Problem**: What user problem are we solving?
|
|
6
|
+
- **Goals**: Success metrics (KPIs).
|
|
7
|
+
- **Target Audience**: Who is this for?
|
|
8
|
+
|
|
9
|
+
## 2. User Flows
|
|
10
|
+
|
|
11
|
+
_(Describe the high-level flow step-by-step)_
|
|
12
|
+
|
|
13
|
+
1. User logs in...
|
|
14
|
+
2. User sees dashboard...
|
|
15
|
+
|
|
16
|
+
## 3. Functional Requirements
|
|
17
|
+
|
|
18
|
+
| ID | Priority | Requirement Description | Acceptance Criteria |
|
|
19
|
+
| :---- | :------- | :---------------------- | :------------------ |
|
|
20
|
+
| FR-01 | P0 | System must allow... | ... |
|
|
21
|
+
| FR-02 | P1 | ... | ... |
|
|
22
|
+
|
|
23
|
+
## 4. Non-Functional Requirements
|
|
24
|
+
|
|
25
|
+
- **Performance**: Load time < 200ms
|
|
26
|
+
- **Scalability**: Support 10k concurrent users
|
|
27
|
+
- **Security**: Compliance with GDPR
|
|
28
|
+
|
|
29
|
+
## 5. UI/UX Requirements
|
|
30
|
+
|
|
31
|
+
- **Mobile**: Responsive layout required?
|
|
32
|
+
- **Theme**: Dark mode support?
|
|
33
|
+
_(Link to Figma/Wireframes if available)_
|
|
34
|
+
|
|
35
|
+
## 6. Roadmap / Phases
|
|
36
|
+
|
|
37
|
+
- **Phase 1 (MVP)**: Core features only.
|
|
38
|
+
- **Phase 2**: Nice-to-haves.
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Use Case Specification
|
|
2
|
+
|
|
3
|
+
## UC-[ID]: [Use Case Name]
|
|
4
|
+
|
|
5
|
+
- **Actor(s)**: [Primary Actor], [Secondary Actor]
|
|
6
|
+
- **Description**: Brief summary of the interaction.
|
|
7
|
+
- **Trigger**: What starts this use case?
|
|
8
|
+
- **Preconditions**: What must be true before this starts? (e.g., User is logged in).
|
|
9
|
+
- **Postconditions**: What is the state of the system after success?
|
|
10
|
+
- **Priority**: High/Medium/Low
|
|
11
|
+
|
|
12
|
+
## Main Flow (Happy Path)
|
|
13
|
+
|
|
14
|
+
| Step | Actor Action | System Response |
|
|
15
|
+
| :--- | :----------------------- | :--------------------------------- |
|
|
16
|
+
| 1 | Navigate to "My Profile" | Displays profile form |
|
|
17
|
+
| 2 | Updates phone number | Validates format |
|
|
18
|
+
| 3 | Clicks "Save" | Saves data and shows success toast |
|
|
19
|
+
|
|
20
|
+
## Alternative Flows
|
|
21
|
+
|
|
22
|
+
### A1. Invalid Input
|
|
23
|
+
|
|
24
|
+
- **At Step 2**: User enters invalid phone format.
|
|
25
|
+
- **System**: Displays "Invalid format" error below field.
|
|
26
|
+
- **Return**: To Step 2.
|
|
27
|
+
|
|
28
|
+
### A2. Network Error
|
|
29
|
+
|
|
30
|
+
- **At Step 3**: API call fails.
|
|
31
|
+
- **System**: Displays "Connection failed, retry?" modal.
|
|
32
|
+
|
|
33
|
+
## Exceptions (Error Conditions)
|
|
34
|
+
|
|
35
|
+
- **E1**: Database is locked.
|
|
36
|
+
- **E2**: Session expires during action.
|
|
37
|
+
|
|
38
|
+
## Business Rules associated
|
|
39
|
+
|
|
40
|
+
- **BR-05**: Phone number must be unique.
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# User Story Template (Agile/Scrum)
|
|
2
|
+
|
|
3
|
+
## Core Story
|
|
4
|
+
|
|
5
|
+
**Title**: [User Role] - [Feature Key Name]
|
|
6
|
+
|
|
7
|
+
> **As a** [Role]
|
|
8
|
+
> **I want** [Feature/Action]
|
|
9
|
+
> **So that** [Benefit/Value]
|
|
10
|
+
|
|
11
|
+
## Acceptance Criteria (Gherkin)
|
|
12
|
+
|
|
13
|
+
```gherkin
|
|
14
|
+
Scenario: [Happy Path Title]
|
|
15
|
+
Given [Precondition]
|
|
16
|
+
When [Action]
|
|
17
|
+
Then [Expected Result]
|
|
18
|
+
|
|
19
|
+
Scenario: [Negative Path Title]
|
|
20
|
+
Given [Precondition]
|
|
21
|
+
When [Action on Edge Case]
|
|
22
|
+
Then [Error Message/Fallback state]
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Developer Notes
|
|
26
|
+
|
|
27
|
+
- **API Dependency**: [Link to API Endpoint if known]
|
|
28
|
+
- **UI Component**: [Component Name/Design Link]
|
|
29
|
+
- **State Impact**: [Which Redux/Context slice is affected]
|
|
30
|
+
|
|
31
|
+
## Definition of Done (DoD)
|
|
32
|
+
|
|
33
|
+
- [ ] Component implemented
|
|
34
|
+
- [ ] Unit tests passed
|
|
35
|
+
- [ ] Visual regression tested
|
|
36
|
+
- [ ] Accessibility (ARIA) checked
|