gabbe-kit 1.0.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/LICENSE +25 -0
- package/LICENSE-CODE +202 -0
- package/README.md +817 -0
- package/agents/AGENTS.md +542 -0
- package/agents/CONSTITUTION.md +188 -0
- package/agents/guides/00-index.md +142 -0
- package/agents/guides/ai/a2ui-protocols.md +71 -0
- package/agents/guides/ai/actor-agent-frameworks.md +82 -0
- package/agents/guides/ai/agent-communication.md +146 -0
- package/agents/guides/ai/agent-identity-trust.md +69 -0
- package/agents/guides/ai/agent-only-cognition.md +73 -0
- package/agents/guides/ai/agent-only-swarms.md +70 -0
- package/agents/guides/ai/agent-operating-ergonomics.md +52 -0
- package/agents/guides/ai/agent-ui.md +106 -0
- package/agents/guides/ai/ai-agentic.md +309 -0
- package/agents/guides/ai/beyond-llms.md +60 -0
- package/agents/guides/ai/dynamic-capability-loading.md +121 -0
- package/agents/guides/ai/gabbe-innovations.md +111 -0
- package/agents/guides/ai/model-customization-decisions.md +78 -0
- package/agents/guides/ai/multi-agent-systems.md +85 -0
- package/agents/guides/ai/self-evolving-skills.md +137 -0
- package/agents/guides/ai/self-healing-summary.md +21 -0
- package/agents/guides/ai/visual-mcp-integration.md +106 -0
- package/agents/guides/architecture/api-standards.md +61 -0
- package/agents/guides/architecture/blockchain-dlt.md +36 -0
- package/agents/guides/architecture/critical-systems-arch.md +66 -0
- package/agents/guides/architecture/event-driven-architecture.md +39 -0
- package/agents/guides/architecture/microservices.md +292 -0
- package/agents/guides/architecture/monolith.md +303 -0
- package/agents/guides/architecture/orchestration.md +75 -0
- package/agents/guides/architecture/system-qualities.md +51 -0
- package/agents/guides/architecture/system-scalability.md +47 -0
- package/agents/guides/architecture/systems-architecture.md +506 -0
- package/agents/guides/data/semantic-web.md +23 -0
- package/agents/guides/data/sql-nosql.md +305 -0
- package/agents/guides/industry/engineering-standards.md +36 -0
- package/agents/guides/industry/global-standards.md +24 -0
- package/agents/guides/industry/healthcare-fhir.md +33 -0
- package/agents/guides/industry/industrial-iot.md +33 -0
- package/agents/guides/industry/telecom-networks.md +34 -0
- package/agents/guides/languages/c-sharp.md +66 -0
- package/agents/guides/languages/go-lang.md +251 -0
- package/agents/guides/languages/java.md +73 -0
- package/agents/guides/languages/js-ts-nodejs.md +361 -0
- package/agents/guides/languages/nodejs-advanced.md +56 -0
- package/agents/guides/languages/php-laravel.md +376 -0
- package/agents/guides/languages/python-fastapi-ai.md +257 -0
- package/agents/guides/languages/rust.md +73 -0
- package/agents/guides/ops/compliance-audit.md +177 -0
- package/agents/guides/ops/cost-optimization.md +57 -0
- package/agents/guides/ops/dev-environments.md +67 -0
- package/agents/guides/ops/dev-workflow.md +44 -0
- package/agents/guides/ops/gabbe-cli-workflows.md +252 -0
- package/agents/guides/ops/production-health.md +62 -0
- package/agents/guides/ops/troubleshooting-guide.md +69 -0
- package/agents/guides/patterns/agentic-design-patterns.md +308 -0
- package/agents/guides/patterns/agentic-patterns.md +43 -0
- package/agents/guides/patterns/ai-native-scenarios.md +71 -0
- package/agents/guides/patterns/autonomous-swarm-patterns.md +42 -0
- package/agents/guides/patterns/design-patterns.md +68 -0
- package/agents/guides/patterns/enterprise-migration-scenario.md +58 -0
- package/agents/guides/patterns/enterprise-patterns.md +56 -0
- package/agents/guides/patterns/software-design-patterns.md +106 -0
- package/agents/guides/patterns/time-complexity-analysis.md +116 -0
- package/agents/guides/planning/product-requirements.md +407 -0
- package/agents/guides/planning/strategic-analysis.md +98 -0
- package/agents/guides/planning/visual-product-specs.md +162 -0
- package/agents/guides/principles/clean-code-standards.md +51 -0
- package/agents/guides/principles/computing-foundations.md +87 -0
- package/agents/guides/principles/diagramming-standards.md +568 -0
- package/agents/guides/principles/evaluation-strategy.md +103 -0
- package/agents/guides/principles/future-tech.md +35 -0
- package/agents/guides/principles/human-agent-collaboration.md +54 -0
- package/agents/guides/principles/legacy-tech.md +61 -0
- package/agents/guides/principles/mathematical-foundations.md +103 -0
- package/agents/guides/principles/modeling-methods.md +97 -0
- package/agents/guides/principles/no-code-integration.md +84 -0
- package/agents/guides/principles/testing-strategy.md +97 -0
- package/agents/guides/principles/visual-design-system.md +44 -0
- package/agents/guides/processes/RARV_CYCLE.md +262 -0
- package/agents/guides/processes/extension-protocol.md +183 -0
- package/agents/guides/processes/full-system-lifecycle.md +47 -0
- package/agents/guides/processes/knowledge-integration.md +82 -0
- package/agents/guides/processes/loki-sdlc-phases.md +446 -0
- package/agents/guides/product/green-software.md +38 -0
- package/agents/guides/product/sustainability-checks.md +29 -0
- package/agents/guides/security/ai-risk-standards-map.md +98 -0
- package/agents/guides/security/api-security.md +51 -0
- package/agents/guides/security/cryptography-standards.md +38 -0
- package/agents/guides/security/privacy-data-protection.md +41 -0
- package/agents/guides/security/secure-architecture.md +43 -0
- package/agents/guides/security/threat-modeling.md +46 -0
- package/agents/memory/AUDIT_LOG.md +48 -0
- package/agents/memory/CONTINUITY.md +49 -0
- package/agents/memory/PROJECT_STATE.md +134 -0
- package/agents/memory/RESUME_POINTER.md +15 -0
- package/agents/memory/episodic/DECISION_LOG_TEMPLATE.md +104 -0
- package/agents/memory/semantic/PROJECT_KNOWLEDGE_TEMPLATE.md +194 -0
- package/agents/memory/semantic/VECTOR_DB_CONFIG_TEMPLATE.json +46 -0
- package/agents/personas/00-index.md +148 -0
- package/agents/personas/biz-compliance.md +112 -0
- package/agents/personas/biz-legal.md +131 -0
- package/agents/personas/eng-api.md +110 -0
- package/agents/personas/eng-backend.md +113 -0
- package/agents/personas/eng-data.md +50 -0
- package/agents/personas/eng-database.md +95 -0
- package/agents/personas/eng-frontend.md +75 -0
- package/agents/personas/eng-infra.md +105 -0
- package/agents/personas/eng-messaging.md +50 -0
- package/agents/personas/eng-ml.md +50 -0
- package/agents/personas/eng-mobile.md +75 -0
- package/agents/personas/eng-perf.md +90 -0
- package/agents/personas/eng-qa.md +125 -0
- package/agents/personas/eng-tooling.md +49 -0
- package/agents/personas/ops-compliance.md +109 -0
- package/agents/personas/ops-cost.md +92 -0
- package/agents/personas/ops-devops.md +85 -0
- package/agents/personas/ops-incident.md +123 -0
- package/agents/personas/ops-monitor.md +89 -0
- package/agents/personas/ops-release.md +91 -0
- package/agents/personas/ops-security.md +104 -0
- package/agents/personas/ops-sre.md +85 -0
- package/agents/personas/orch-coordinator.md +140 -0
- package/agents/personas/orch-judge.md +135 -0
- package/agents/personas/orch-planner.md +114 -0
- package/agents/personas/orch-researcher.md +165 -0
- package/agents/personas/prod-architect.md +110 -0
- package/agents/personas/prod-design.md +112 -0
- package/agents/personas/prod-ethicist.md +50 -0
- package/agents/personas/prod-integration.md +120 -0
- package/agents/personas/prod-pm.md +115 -0
- package/agents/personas/prod-product-ops.md +128 -0
- package/agents/personas/prod-research.md +49 -0
- package/agents/personas/prod-safety-engineer.md +28 -0
- package/agents/personas/prod-tech-lead.md +119 -0
- package/agents/personas/ui-design.md +81 -0
- package/agents/scripts/check_skills_docs.py +120 -0
- package/agents/scripts/compile_skills.py +284 -0
- package/agents/scripts/comprehensive_checker.py +187 -0
- package/agents/scripts/dump-context.sh +37 -0
- package/agents/scripts/eval_skills.py +268 -0
- package/agents/scripts/preflight_summary.sh +80 -0
- package/agents/scripts/report_duplicates.py +125 -0
- package/agents/scripts/setup-context.ps1 +250 -0
- package/agents/scripts/setup-context.sh +398 -0
- package/agents/scripts/state_export.sh +84 -0
- package/agents/scripts/state_import.sh +99 -0
- package/agents/scripts/validate_integrity.py +98 -0
- package/agents/scripts/validate_links.py +96 -0
- package/agents/scripts/validate_methodology_graph.py +194 -0
- package/agents/scripts/validate_skills.py +81 -0
- package/agents/scripts/verify_e2e_init_flows.py +246 -0
- package/agents/scripts/verify_setup_simulation.py +104 -0
- package/agents/scripts/verify_triggers_and_mcps.py +159 -0
- package/agents/scripts/verify_use_cases.py +498 -0
- package/agents/skills/00-index.md +322 -0
- package/agents/skills/ai/a2ui-protocols.skill.md +31 -0
- package/agents/skills/ai/actor-agent-frameworks.skill.md +31 -0
- package/agents/skills/ai/agent-communication.skill.md +36 -0
- package/agents/skills/ai/agent-ui.skill.md +31 -0
- package/agents/skills/ai/autonomous-swarm-patterns.skill.md +31 -0
- package/agents/skills/ai/beyond-llms.skill.md +31 -0
- package/agents/skills/ai/context-engineering.skill.md +79 -0
- package/agents/skills/ai/llm-as-judge.skill.md +97 -0
- package/agents/skills/ai/multi-agent-systems.skill.md +31 -0
- package/agents/skills/ai/rag-evaluation.skill.md +93 -0
- package/agents/skills/ai/reasoning-patterns.skill.md +125 -0
- package/agents/skills/architecture/adaptive-architecture.skill.md +51 -0
- package/agents/skills/architecture/api-design.skill.md +92 -0
- package/agents/skills/architecture/api-standards.skill.md +31 -0
- package/agents/skills/architecture/arch-debt.skill.md +180 -0
- package/agents/skills/architecture/arch-design.skill.md +304 -0
- package/agents/skills/architecture/arch-patterns.skill.md +52 -0
- package/agents/skills/architecture/arch-review.skill.md +326 -0
- package/agents/skills/architecture/architecture-governance.skill.md +62 -0
- package/agents/skills/architecture/attribute-driven-design.skill.md +108 -0
- package/agents/skills/architecture/blockchain-dlt.skill.md +28 -0
- package/agents/skills/architecture/compatibility-design.skill.md +51 -0
- package/agents/skills/architecture/critical-systems-arch.skill.md +31 -0
- package/agents/skills/architecture/design-patterns.skill.md +59 -0
- package/agents/skills/architecture/diagramming.skill.md +380 -0
- package/agents/skills/architecture/domain-model.skill.md +294 -0
- package/agents/skills/architecture/enterprise-migration-scenario.skill.md +31 -0
- package/agents/skills/architecture/enterprise-patterns.skill.md +31 -0
- package/agents/skills/architecture/error-handling-strategy.skill.md +58 -0
- package/agents/skills/architecture/event-driven-architecture.skill.md +31 -0
- package/agents/skills/architecture/event-governance.skill.md +55 -0
- package/agents/skills/architecture/fitness-functions.skill.md +111 -0
- package/agents/skills/architecture/graphql-schema.skill.md +64 -0
- package/agents/skills/architecture/legacy-modernization.skill.md +51 -0
- package/agents/skills/architecture/microservices.skill.md +31 -0
- package/agents/skills/architecture/middleware-design.skill.md +59 -0
- package/agents/skills/architecture/monolith.skill.md +31 -0
- package/agents/skills/architecture/realtime-comm.skill.md +52 -0
- package/agents/skills/architecture/state-management.skill.md +72 -0
- package/agents/skills/architecture/system-qualities.skill.md +31 -0
- package/agents/skills/architecture/system-scalability.skill.md +31 -0
- package/agents/skills/architecture/systems-architecture.skill.md +31 -0
- package/agents/skills/architecture/visual-whiteboarding.skill.md +33 -0
- package/agents/skills/brain/README.md +70 -0
- package/agents/skills/brain/active-inference.skill.md +74 -0
- package/agents/skills/brain/brain-mode.skill.md +125 -0
- package/agents/skills/brain/cognitive-architectures.skill.md +53 -0
- package/agents/skills/brain/cognitive-testing.skill.md +62 -0
- package/agents/skills/brain/consciousness-loop.skill.md +68 -0
- package/agents/skills/brain/cost-benefit-router.skill.md +89 -0
- package/agents/skills/brain/episodic-consolidation.skill.md +43 -0
- package/agents/skills/brain/epistemology-knowledge.skill.md +54 -0
- package/agents/skills/brain/global-workspace.skill.md +77 -0
- package/agents/skills/brain/learning-adaptation.skill.md +68 -0
- package/agents/skills/brain/loki-mode.skill.md +267 -0
- package/agents/skills/brain/neuroscience-foundations.skill.md +52 -0
- package/agents/skills/brain/scripts/active_inference_loop.py +92 -0
- package/agents/skills/brain/scripts/cognition_test.py +80 -0
- package/agents/skills/brain/scripts/global_workspace.py +104 -0
- package/agents/skills/brain/self-improvement.skill.md +80 -0
- package/agents/skills/brain/sensory-motor.skill.md +61 -0
- package/agents/skills/brain/sequential-thinking.skill.md +48 -0
- package/agents/skills/brain/working-memory.skill.md +47 -0
- package/agents/skills/coding/agent-trajectory-eval.skill.md +92 -0
- package/agents/skills/coding/artisan-commands.skill.md +52 -0
- package/agents/skills/coding/browser-tdd.skill.md +131 -0
- package/agents/skills/coding/chaos-fault-injection.skill.md +116 -0
- package/agents/skills/coding/ci-autofix.skill.md +53 -0
- package/agents/skills/coding/clean-coder.skill.md +58 -0
- package/agents/skills/coding/code-review.skill.md +100 -0
- package/agents/skills/coding/debug.skill.md +100 -0
- package/agents/skills/coding/documentation.skill.md +149 -0
- package/agents/skills/coding/eval-driven-development.skill.md +107 -0
- package/agents/skills/coding/evals/code-review.eval.yaml +29 -0
- package/agents/skills/coding/excalidraw.skill.md +90 -0
- package/agents/skills/coding/file-processing.skill.md +55 -0
- package/agents/skills/coding/git-workflow.skill.md +153 -0
- package/agents/skills/coding/metamorphic-testing.skill.md +113 -0
- package/agents/skills/coding/mobile-dev.skill.md +41 -0
- package/agents/skills/coding/nodejs-expert.skill.md +23 -0
- package/agents/skills/coding/output-validation.skill.md +57 -0
- package/agents/skills/coding/pbt-strategy.skill.md +117 -0
- package/agents/skills/coding/performant-ai.skill.md +62 -0
- package/agents/skills/coding/performant-go.skill.md +61 -0
- package/agents/skills/coding/performant-laravel.skill.md +70 -0
- package/agents/skills/coding/performant-nodejs.skill.md +67 -0
- package/agents/skills/coding/performant-php.skill.md +53 -0
- package/agents/skills/coding/performant-python.skill.md +62 -0
- package/agents/skills/coding/refactor.skill.md +124 -0
- package/agents/skills/coding/secure-coding.skill.md +57 -0
- package/agents/skills/coding/sketch-to-diagram.skill.md +106 -0
- package/agents/skills/coding/spec-driven-development.skill.md +110 -0
- package/agents/skills/coding/tdd-cycle.skill.md +92 -0
- package/agents/skills/coding/testing-strategy.skill.md +74 -0
- package/agents/skills/coding/time-complexity.skill.md +112 -0
- package/agents/skills/coding/tldraw-canvas.skill.md +109 -0
- package/agents/skills/coding/tool-construction.skill.md +47 -0
- package/agents/skills/coding/ui-gen.skill.md +64 -0
- package/agents/skills/coding/vibe-coding.skill.md +63 -0
- package/agents/skills/coding/visual-design.skill.md +65 -0
- package/agents/skills/coordination/agent-interop.skill.md +72 -0
- package/agents/skills/coordination/agent-protocol.skill.md +62 -0
- package/agents/skills/coordination/agent-workflow-patterns.skill.md +123 -0
- package/agents/skills/coordination/agentic-linter.skill.md +134 -0
- package/agents/skills/coordination/agentic-patterns.skill.md +79 -0
- package/agents/skills/coordination/meta-optimize.skill.md +62 -0
- package/agents/skills/coordination/meta-prompting.skill.md +46 -0
- package/agents/skills/coordination/multi-agent-orch.skill.md +78 -0
- package/agents/skills/coordination/persona-selector.skill.md +78 -0
- package/agents/skills/coordination/self-optimize.skill.md +81 -0
- package/agents/skills/coordination/swarm-consensus.skill.md +52 -0
- package/agents/skills/core/agent-analytics.skill.md +74 -0
- package/agents/skills/core/audit-trail.skill.md +122 -0
- package/agents/skills/core/clarify.skill.md +89 -0
- package/agents/skills/core/emerging-tech.skill.md +52 -0
- package/agents/skills/core/empirical-methods.skill.md +101 -0
- package/agents/skills/core/evals/clarify.eval.yaml +29 -0
- package/agents/skills/core/evals/integrity-check.eval.yaml +23 -0
- package/agents/skills/core/evals/research.eval.yaml +23 -0
- package/agents/skills/core/final-review.skill.md +66 -0
- package/agents/skills/core/integrity-check.skill.md +149 -0
- package/agents/skills/core/knowledge-connect.skill.md +77 -0
- package/agents/skills/core/knowledge-gap.skill.md +123 -0
- package/agents/skills/core/preflight.skill.md +106 -0
- package/agents/skills/core/research.skill.md +107 -0
- package/agents/skills/core/retrospective.skill.md +59 -0
- package/agents/skills/core/sdlc-checkpoint.skill.md +151 -0
- package/agents/skills/core/self-heal.skill.md +163 -0
- package/agents/skills/core/session-resume.skill.md +125 -0
- package/agents/skills/core/skills-registry.skill.md +65 -0
- package/agents/skills/core/state-portability.skill.md +89 -0
- package/agents/skills/core/state-preserve.skill.md +76 -0
- package/agents/skills/core/system-lifecycle.skill.md +51 -0
- package/agents/skills/core/update-scan.skill.md +92 -0
- package/agents/skills/data/data-engineering.skill.md +56 -0
- package/agents/skills/data/data-governance.skill.md +49 -0
- package/agents/skills/data/db-migration.skill.md +136 -0
- package/agents/skills/data/semantic-web.skill.md +28 -0
- package/agents/skills/data/sql-optimization.skill.md +78 -0
- package/agents/skills/industry/engineering-standards.skill.md +31 -0
- package/agents/skills/industry/global-standards.skill.md +30 -0
- package/agents/skills/industry/healthcare-fhir.skill.md +28 -0
- package/agents/skills/industry/industrial-iot.skill.md +30 -0
- package/agents/skills/industry/telecom-networks.skill.md +30 -0
- package/agents/skills/ops/caching-strategy.skill.md +77 -0
- package/agents/skills/ops/capacity-planning.skill.md +67 -0
- package/agents/skills/ops/cloud-deploy.skill.md +55 -0
- package/agents/skills/ops/configuration-management.skill.md +107 -0
- package/agents/skills/ops/cost-optimization.skill.md +39 -0
- package/agents/skills/ops/decommission-sunset.skill.md +64 -0
- package/agents/skills/ops/dependency-lifecycle.skill.md +63 -0
- package/agents/skills/ops/deployment.skill.md +217 -0
- package/agents/skills/ops/dev-environments.skill.md +31 -0
- package/agents/skills/ops/dev-workflow.skill.md +28 -0
- package/agents/skills/ops/docker-dev.skill.md +52 -0
- package/agents/skills/ops/enterprise-integration.skill.md +53 -0
- package/agents/skills/ops/feature-flag-management.skill.md +59 -0
- package/agents/skills/ops/incident-response.skill.md +40 -0
- package/agents/skills/ops/infra-devops.skill.md +53 -0
- package/agents/skills/ops/k8s-dev.skill.md +51 -0
- package/agents/skills/ops/memory-optimization.skill.md +45 -0
- package/agents/skills/ops/observability-stack-setup.skill.md +62 -0
- package/agents/skills/ops/performance-audit.skill.md +178 -0
- package/agents/skills/ops/performance-optimization.skill.md +51 -0
- package/agents/skills/ops/production-health.skill.md +85 -0
- package/agents/skills/ops/production-verifier.skill.md +50 -0
- package/agents/skills/ops/queue-management.skill.md +52 -0
- package/agents/skills/ops/release-management.skill.md +39 -0
- package/agents/skills/ops/release-validation.skill.md +51 -0
- package/agents/skills/ops/reliability-sre.skill.md +51 -0
- package/agents/skills/ops/runbook-authoring.skill.md +64 -0
- package/agents/skills/ops/system-benchmark.skill.md +69 -0
- package/agents/skills/ops/tech-debt.skill.md +143 -0
- package/agents/skills/ops/troubleshooting-guide.skill.md +31 -0
- package/agents/skills/product/accessibility.skill.md +143 -0
- package/agents/skills/product/adr-writer.skill.md +110 -0
- package/agents/skills/product/business-case.skill.md +70 -0
- package/agents/skills/product/change-management.skill.md +90 -0
- package/agents/skills/product/decompose.skill.md +75 -0
- package/agents/skills/product/design-thinking.skill.md +62 -0
- package/agents/skills/product/estimation-sizing.skill.md +87 -0
- package/agents/skills/product/evals/spec-writer.eval.yaml +22 -0
- package/agents/skills/product/financial-governance.skill.md +88 -0
- package/agents/skills/product/green-software.skill.md +46 -0
- package/agents/skills/product/ideation-facilitation.skill.md +87 -0
- package/agents/skills/product/market-analysis.skill.md +56 -0
- package/agents/skills/product/opportunity-assessment.skill.md +89 -0
- package/agents/skills/product/product-analytics.skill.md +92 -0
- package/agents/skills/product/professional-practice.skill.md +105 -0
- package/agents/skills/product/req-elicitation.skill.md +292 -0
- package/agents/skills/product/req-review.skill.md +280 -0
- package/agents/skills/product/spec-analyze.skill.md +98 -0
- package/agents/skills/product/spec-writer.skill.md +114 -0
- package/agents/skills/product/stakeholder-management.skill.md +54 -0
- package/agents/skills/product/sustainability-checks.skill.md +29 -0
- package/agents/skills/product/systems-thinking.skill.md +56 -0
- package/agents/skills/product/user-research-synthesis.skill.md +85 -0
- package/agents/skills/product/user-story-mapping.skill.md +54 -0
- package/agents/skills/product/visual-specs.skill.md +112 -0
- package/agents/skills/security/access-control.skill.md +45 -0
- package/agents/skills/security/agent-sandboxing.skill.md +69 -0
- package/agents/skills/security/ai-ethics-compliance.skill.md +46 -0
- package/agents/skills/security/ai-red-teaming.skill.md +74 -0
- package/agents/skills/security/ai-safety-guardrails.skill.md +60 -0
- package/agents/skills/security/api-security.skill.md +31 -0
- package/agents/skills/security/backup-recovery.skill.md +49 -0
- package/agents/skills/security/compliance-review.skill.md +152 -0
- package/agents/skills/security/cryptography-standards.skill.md +31 -0
- package/agents/skills/security/dependency-security.skill.md +47 -0
- package/agents/skills/security/hazard-analysis.skill.md +53 -0
- package/agents/skills/security/legal-review.skill.md +41 -0
- package/agents/skills/security/log-analysis.skill.md +68 -0
- package/agents/skills/security/network-security.skill.md +64 -0
- package/agents/skills/security/privacy-audit.skill.md +137 -0
- package/agents/skills/security/privacy-data-protection.skill.md +31 -0
- package/agents/skills/security/prompt-injection-defense.skill.md +67 -0
- package/agents/skills/security/reliability-engineering.skill.md +47 -0
- package/agents/skills/security/safety-scan.skill.md +49 -0
- package/agents/skills/security/secrets-management.skill.md +65 -0
- package/agents/skills/security/secure-architecture.skill.md +31 -0
- package/agents/skills/security/security-audit.skill.md +164 -0
- package/agents/skills/security/threat-model.skill.md +120 -0
- package/agents/skills/security/traceability-audit.skill.md +48 -0
- package/agents/templates/00-index.md +162 -0
- package/agents/templates/architecture/ADAPTIVE_SYSTEM_TEMPLATE.md +35 -0
- package/agents/templates/architecture/ADD_WORKBOOK_TEMPLATE.md +81 -0
- package/agents/templates/architecture/ADR_TEMPLATE.md +136 -0
- package/agents/templates/architecture/ARCHITECTURE_DECISION_MATRIX.md +169 -0
- package/agents/templates/architecture/ARCHITECTURE_REVIEW_TEMPLATE.md +241 -0
- package/agents/templates/architecture/ARCHITECTURE_VIEWS_TEMPLATE.md +353 -0
- package/agents/templates/architecture/ARCH_DECISION_FRAMEWORK.md +32 -0
- package/agents/templates/architecture/C4_ARCHITECTURE_TEMPLATE.md +185 -0
- package/agents/templates/architecture/CAPABILITY_MAP_TEMPLATE.md +153 -0
- package/agents/templates/architecture/CONTEXT_MAP_TEMPLATE.md +196 -0
- package/agents/templates/architecture/DESIGN_PATTERN_USAGE.md +24 -0
- package/agents/templates/architecture/DOMAIN_MODEL_TEMPLATE.md +254 -0
- package/agents/templates/architecture/FITNESS_FUNCTION_TEMPLATE.md +59 -0
- package/agents/templates/architecture/INTEGRATION_SPEC_TEMPLATE.md +38 -0
- package/agents/templates/architecture/LEGACY_AUDIT_TEMPLATE.md +34 -0
- package/agents/templates/architecture/QUALITY_ATTRIBUTES_TEMPLATE.md +210 -0
- package/agents/templates/architecture/SCALABILITY_ANALYSIS_TEMPLATE.md +46 -0
- package/agents/templates/architecture/SMART_CONTRACT_TEMPLATE.md +44 -0
- package/agents/templates/architecture/SYSTEM_CONTEXT_TEMPLATE.md +197 -0
- package/agents/templates/brain/ACTIVE_INFERENCE_LOOP_TEMPLATE.md +42 -0
- package/agents/templates/brain/EPISODIC_MEMORY_LOG_TEMPLATE.md +28 -0
- package/agents/templates/brain/GLOBAL_WORKSPACE_CONFIG_TEMPLATE.md +44 -0
- package/agents/templates/brain/KNOWLEDGE_MAP_TEMPLATE.md +53 -0
- package/agents/templates/brain/OODA_LOOP_TRACE_TEMPLATE.md +44 -0
- package/agents/templates/brain/PREDICTION_ERROR_LOG_TEMPLATE.md +33 -0
- package/agents/templates/brain/PROJECT_CONTEXT_TEMPLATE.md +36 -0
- package/agents/templates/brain/SELF_IMPROVEMENT_LOG_TEMPLATE.md +39 -0
- package/agents/templates/brain/WORKING_MEMORY_TEMPLATE.md +34 -0
- package/agents/templates/coding/CLEAN_CODE_CHECKLIST.md +30 -0
- package/agents/templates/coding/DESIGN_TOKENS_TEMPLATE.json +54 -0
- package/agents/templates/coding/DEVCONTAINER_TEMPLATE.json +42 -0
- package/agents/templates/coding/DEV_SPACE_TEMPLATE.yaml +48 -0
- package/agents/templates/coding/E2E_TEST_SUITE_TEMPLATE.md +36 -0
- package/agents/templates/coding/EVAL_PLAN_TEMPLATE.md +85 -0
- package/agents/templates/coding/EVAL_RUBRIC_TEMPLATE.md +57 -0
- package/agents/templates/coding/GOLDEN_DATASET_TEMPLATE.md +73 -0
- package/agents/templates/coding/PROPERTY_TEST_CHECKLIST.md +77 -0
- package/agents/templates/coding/SKETCH_TO_DIAGRAM_TEMPLATE.md +56 -0
- package/agents/templates/coding/TEST_CASE_TEMPLATE.md +28 -0
- package/agents/templates/coding/TEST_PLAN_TEMPLATE.md +36 -0
- package/agents/templates/coding/TIME_COMPLEXITY_REPORT_TEMPLATE.md +61 -0
- package/agents/templates/coordination/AGENTS_TEMPLATE.md +540 -0
- package/agents/templates/coordination/AGENT_HANDSHAKE_TEMPLATE.json +37 -0
- package/agents/templates/coordination/AGENT_PROFILE_TEMPLATE.md +28 -0
- package/agents/templates/coordination/SWARM_ARCHITECTURE_TEMPLATE.md +53 -0
- package/agents/templates/coordination/SWARM_CONFIG_TEMPLATE.json +45 -0
- package/agents/templates/core/AUDIT_LOG_TEMPLATE.md +75 -0
- package/agents/templates/core/BUG_REPORT_TEMPLATE.md +136 -0
- package/agents/templates/core/DEPENDENCY_GRAPH_TEMPLATE.md +63 -0
- package/agents/templates/core/ESTIMATION_TEMPLATE.md +70 -0
- package/agents/templates/core/MCP_CONFIG_TEMPLATE.json +807 -0
- package/agents/templates/core/PLAN_TEMPLATE.md +162 -0
- package/agents/templates/core/PROJECT_RETROSPECTIVE_TEMPLATE.md +67 -0
- package/agents/templates/core/SDLC_TRACKER.md +217 -0
- package/agents/templates/core/SESSION_SNAPSHOT_TEMPLATE.md +168 -0
- package/agents/templates/core/SYSTEM_ANALYSIS_TEMPLATE.md +52 -0
- package/agents/templates/core/TASKS_TEMPLATE.md +104 -0
- package/agents/templates/core/TRACEABILITY_MATRIX_TEMPLATE.md +18 -0
- package/agents/templates/core/WHITEBOARD_DESIGN_TEMPLATE.md +46 -0
- package/agents/templates/data/DATABASE_SCHEMA_TEMPLATE.md +38 -0
- package/agents/templates/data/DATA_PIPELINE_TEMPLATE.md +44 -0
- package/agents/templates/data/ONTOLOGY_TEMPLATE.md +52 -0
- package/agents/templates/industry/ENGINEERING_STANDARDS_REVIEW_TEMPLATE.md +43 -0
- package/agents/templates/industry/FHIR_INTEGRATION_TEMPLATE.md +53 -0
- package/agents/templates/industry/GLOBAL_STANDARDS_AUDIT_TEMPLATE.md +45 -0
- package/agents/templates/industry/IOT_TELEMETRY_TEMPLATE.md +59 -0
- package/agents/templates/industry/TELECOM_API_TEMPLATE.md +50 -0
- package/agents/templates/ops/BENCHMARK_REPORT_TEMPLATE.md +48 -0
- package/agents/templates/ops/CAPACITY_PLAN_TEMPLATE.md +41 -0
- package/agents/templates/ops/COST_OPTIMIZATION_REPORT_TEMPLATE.md +40 -0
- package/agents/templates/ops/DECOMMISSION_PLAN_TEMPLATE.md +102 -0
- package/agents/templates/ops/DEPLOY_CONFIG_TEMPLATE.md +88 -0
- package/agents/templates/ops/INCIDENT_POSTMORTEM_TEMPLATE.md +39 -0
- package/agents/templates/ops/INFRA_PLAN_TEMPLATE.md +37 -0
- package/agents/templates/ops/RELEASE_READINESS_REPORT.md +35 -0
- package/agents/templates/ops/RUNBOOK_TEMPLATE.md +103 -0
- package/agents/templates/ops/TECH_DEBT_TEMPLATE.md +102 -0
- package/agents/templates/product/BUSINESS_CASE_TEMPLATE.md +42 -0
- package/agents/templates/product/CHANGE_MANAGEMENT_PLAN_TEMPLATE.md +68 -0
- package/agents/templates/product/EMPATHY_MAP_TEMPLATE.md +47 -0
- package/agents/templates/product/EXPERIMENT_PLAN_TEMPLATE.md +84 -0
- package/agents/templates/product/GREEN_SOFTWARE_REPORT_TEMPLATE.md +42 -0
- package/agents/templates/product/IDEATION_LOG_TEMPLATE.md +42 -0
- package/agents/templates/product/NFR_TEMPLATE.md +31 -0
- package/agents/templates/product/PRD_TEMPLATE.md +222 -0
- package/agents/templates/product/PROBLEM_STATEMENT_TEMPLATE.md +32 -0
- package/agents/templates/product/REQUIREMENTS_REVIEW_TEMPLATE.md +173 -0
- package/agents/templates/product/SPEC_TEMPLATE.md +259 -0
- package/agents/templates/product/STAKEHOLDER_REGISTER_TEMPLATE.md +127 -0
- package/agents/templates/product/USER_STORY_MAP_TEMPLATE.md +35 -0
- package/agents/templates/product/VISUAL_SPEC_PACKAGE_TEMPLATE.md +207 -0
- package/agents/templates/security/DATASHEET_TEMPLATE.md +95 -0
- package/agents/templates/security/ETHICAL_IMPACT_ASSESSMENT.md +32 -0
- package/agents/templates/security/HAZARD_LOG.md +17 -0
- package/agents/templates/security/MODEL_CARD_TEMPLATE.md +120 -0
- package/agents/templates/security/SAFETY_CASE.md +39 -0
- package/agents/templates/security/SAFETY_POLICY.md +25 -0
- package/agents/templates/security/SECURITY_CHECKLIST.md +157 -0
- package/agents/templates/security/SYSTEM_CARD_TEMPLATE.md +139 -0
- package/agents/templates/security/THREAT_MODEL_TEMPLATE.md +171 -0
- package/bin/install.js +572 -0
- package/docs/CLI_REFERENCE.md +527 -0
- package/docs/INSTALL.md +68 -0
- package/docs/MCP_CONFIGURATIONS.md +1765 -0
- package/docs/PLATFORM_CONTROLS.md +324 -0
- package/docs/POST_INSTALL.md +75 -0
- package/docs/QUICK_COMMANDS.md +131 -0
- package/docs/QUICK_GUIDE.md +914 -0
- package/docs/README_FULL.md +1451 -0
- package/docs/SCHEMA.md +164 -0
- package/docs/V1_RELEASE_CHECKLIST.md +144 -0
- package/docs/VERIFICATION_GUIDE.md +283 -0
- package/docs/adr/0001-record-architecture-decisions.md +26 -0
- package/docs/adr/0002-brain-active-inference-runtime.md +27 -0
- package/docs/adr/0003-additive-only-emitter-schema-evolution.md +33 -0
- package/docs/assets/GABBE.png +0 -0
- package/docs/gabbe.config.example.json +9 -0
- package/docs/reports/duplication-report.md +30 -0
- package/install.ps1 +90 -0
- package/install.sh +89 -0
- package/package.json +49 -0
- package/scripts/init.py +1036 -0
|
@@ -0,0 +1,254 @@
|
|
|
1
|
+
# Domain Model — [System Name]
|
|
2
|
+
<!-- Technology-agnostic domain model using DDD concepts -->
|
|
3
|
+
<!-- Created by: domain-model.skill -->
|
|
4
|
+
<!-- No technology terms. No database column names. No framework artifacts. -->
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Meta
|
|
9
|
+
|
|
10
|
+
| Field | Value |
|
|
11
|
+
|---|---|
|
|
12
|
+
| **System** | [system name] |
|
|
13
|
+
| **Version** | [1.0] |
|
|
14
|
+
| **Date** | [YYYY-MM-DD] |
|
|
15
|
+
| **Status** | DRAFT / APPROVED |
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## Ubiquitous Language Glossary
|
|
20
|
+
|
|
21
|
+
> The authoritative vocabulary for this system. All team members and all code use these exact terms.
|
|
22
|
+
|
|
23
|
+
| Term | Definition | Context (if context-specific) | Related Terms |
|
|
24
|
+
|---|---|---|---|
|
|
25
|
+
| [Order] | [A confirmed request to purchase one or more products, with associated payment and delivery information] | [Order Management] | [OrderItem, Customer] |
|
|
26
|
+
| [Customer] | [A registered individual who has placed at least one order] | [All contexts] | [Account, User] |
|
|
27
|
+
| [Cart] | [A temporary collection of products a visitor intends to purchase, before order placement] | [Catalog/Cart] | [CartItem, Order] |
|
|
28
|
+
|
|
29
|
+
**Terms deliberately NOT used** (and why):
|
|
30
|
+
|
|
31
|
+
| Avoided term | Use instead | Reason |
|
|
32
|
+
|---|---|---|
|
|
33
|
+
| "User" | "Customer" or "Operator" or "Visitor" | Too generic — ambiguous across contexts |
|
|
34
|
+
| "Record" | "Order", "Invoice", etc. | Not domain language — implementation term |
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## Bounded Contexts
|
|
39
|
+
|
|
40
|
+
### BC-01: [Context Name]
|
|
41
|
+
|
|
42
|
+
**Responsibility**: [One sentence — what business capability this owns]
|
|
43
|
+
|
|
44
|
+
**Core domain?**: [YES — competitive advantage / NO — supporting/generic]
|
|
45
|
+
|
|
46
|
+
**Ubiquitous language** (terms unique to this context):
|
|
47
|
+
- [Term]: [definition within this context]
|
|
48
|
+
- [Term]: [definition within this context]
|
|
49
|
+
|
|
50
|
+
**Team/Owner**: [team or role responsible]
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
### BC-02: [Context Name]
|
|
55
|
+
|
|
56
|
+
**Responsibility**:
|
|
57
|
+
**Core domain?**:
|
|
58
|
+
**Ubiquitous language**:
|
|
59
|
+
**Team/Owner**:
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
## Context Map
|
|
64
|
+
|
|
65
|
+
```mermaid
|
|
66
|
+
graph LR
|
|
67
|
+
subgraph "BC-01: [Name]"
|
|
68
|
+
BC01([BC-01])
|
|
69
|
+
end
|
|
70
|
+
subgraph "BC-02: [Name]"
|
|
71
|
+
BC02([BC-02])
|
|
72
|
+
end
|
|
73
|
+
subgraph "BC-03: [Name]"
|
|
74
|
+
BC03([BC-03])
|
|
75
|
+
end
|
|
76
|
+
|
|
77
|
+
BC01 -->|"OHS → [Interface name]"| BC02
|
|
78
|
+
BC01 -->|"PL → [Event name]"| BC03
|
|
79
|
+
BC02 -->|"ACL ← [translates BC01]"| BC01
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
See `CONTEXT_MAP_TEMPLATE.md` for full context map with relationship explanations.
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
## Aggregate Definitions
|
|
87
|
+
|
|
88
|
+
### Aggregate: [Name]
|
|
89
|
+
|
|
90
|
+
| Field | Value |
|
|
91
|
+
|---|---|
|
|
92
|
+
| **Aggregate Root** | [Entity name that is the access point] |
|
|
93
|
+
| **Bounded Context** | [BC-NNN] |
|
|
94
|
+
| **Business purpose** | [what business operation this aggregate supports] |
|
|
95
|
+
|
|
96
|
+
**Members:**
|
|
97
|
+
| Name | Type | Role |
|
|
98
|
+
|---|---|---|
|
|
99
|
+
| [OrderId] | Value Object | Identity of the aggregate root |
|
|
100
|
+
| [Order] | Entity (Root) | Guards invariants, owns members |
|
|
101
|
+
| [OrderItem] | Entity | Line item within the order |
|
|
102
|
+
| [ShippingAddress] | Value Object | Delivery destination |
|
|
103
|
+
| [Money] | Value Object | Total amount and currency |
|
|
104
|
+
|
|
105
|
+
**Invariants** (business rules that are ALWAYS true):
|
|
106
|
+
```
|
|
107
|
+
1. An Order must have at least one OrderItem.
|
|
108
|
+
2. Order total must equal the sum of (OrderItem.quantity × OrderItem.unitPrice).
|
|
109
|
+
3. An Order in [Delivered] state cannot transition to [Cancelled].
|
|
110
|
+
4. OrderItem quantity must be ≥ 1.
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
**Lifecycle (State Machine):**
|
|
114
|
+
```mermaid
|
|
115
|
+
stateDiagram-v2
|
|
116
|
+
[*] --> Pending : OrderPlaced
|
|
117
|
+
Pending --> Confirmed : PaymentReceived
|
|
118
|
+
Pending --> Cancelled : PaymentFailed
|
|
119
|
+
Confirmed --> Shipped : Dispatched
|
|
120
|
+
Confirmed --> Cancelled : CustomerCancelled [before dispatch]
|
|
121
|
+
Shipped --> Delivered : DeliveryConfirmed
|
|
122
|
+
Delivered --> [*]
|
|
123
|
+
Cancelled --> [*]
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
**Domain Events emitted:**
|
|
127
|
+
| Event | When emitted | Payload |
|
|
128
|
+
|---|---|---|
|
|
129
|
+
| OrderPlaced | When order is first created | {orderId, customerId, items, total} |
|
|
130
|
+
| OrderConfirmed | When payment is received | {orderId, paymentId} |
|
|
131
|
+
| OrderCancelled | When cancellation is processed | {orderId, reason} |
|
|
132
|
+
| OrderShipped | When fulfilment dispatches | {orderId, trackingId, estimatedDelivery} |
|
|
133
|
+
| OrderDelivered | When delivery confirmed | {orderId, deliveredAt} |
|
|
134
|
+
|
|
135
|
+
---
|
|
136
|
+
|
|
137
|
+
### Aggregate: [Another Aggregate Name]
|
|
138
|
+
|
|
139
|
+
| Field | Value |
|
|
140
|
+
|---|---|
|
|
141
|
+
| **Aggregate Root** | |
|
|
142
|
+
| **Bounded Context** | |
|
|
143
|
+
| **Business purpose** | |
|
|
144
|
+
|
|
145
|
+
**Members:**
|
|
146
|
+
**Invariants:**
|
|
147
|
+
**Lifecycle:**
|
|
148
|
+
**Domain Events:**
|
|
149
|
+
|
|
150
|
+
---
|
|
151
|
+
|
|
152
|
+
## Value Objects
|
|
153
|
+
|
|
154
|
+
| Value Object | Attributes | Validation Rules | Immutable? |
|
|
155
|
+
|---|---|---|---|
|
|
156
|
+
| [Money] | amount (decimal), currency (ISO 4217) | amount ≥ 0; currency must be valid ISO code | YES |
|
|
157
|
+
| [EmailAddress] | value (string) | Must match RFC 5322 format; case-insensitive | YES |
|
|
158
|
+
| [PhoneNumber] | countryCode, number | Must be E.164 format | YES |
|
|
159
|
+
| [DateRange] | startDate, endDate | startDate must be ≤ endDate | YES |
|
|
160
|
+
|
|
161
|
+
---
|
|
162
|
+
|
|
163
|
+
## Domain Services
|
|
164
|
+
|
|
165
|
+
Domain services contain business logic that doesn't naturally fit within one aggregate:
|
|
166
|
+
|
|
167
|
+
| Domain Service | Responsibility | Input | Output |
|
|
168
|
+
|---|---|---|---|
|
|
169
|
+
| [PricingCalculator] | Calculate final price including discounts, taxes | {items, customerId, promoCode} | {subtotal, discounts, tax, total} |
|
|
170
|
+
| [InventoryChecker] | Verify sufficient stock across multiple products | {items[]} | {available: boolean, shortfall[]} |
|
|
171
|
+
|
|
172
|
+
---
|
|
173
|
+
|
|
174
|
+
## Domain Events Catalog
|
|
175
|
+
|
|
176
|
+
| Event | Context | Emitter | Consumers | Payload |
|
|
177
|
+
|---|---|---|---|---|
|
|
178
|
+
| [OrderPlaced] | Order Mgmt | Order aggregate | Inventory, Notification, Analytics | {orderId, customerId, items, total, placedAt} |
|
|
179
|
+
| [PaymentFailed] | Payment | Payment aggregate | Order Mgmt, Notification | {paymentId, orderId, reason, failedAt} |
|
|
180
|
+
| [InventoryDepleted] | Inventory | Inventory aggregate | Catalog, Purchasing | {productId, depletedAt} |
|
|
181
|
+
|
|
182
|
+
---
|
|
183
|
+
|
|
184
|
+
## Domain Model Diagram
|
|
185
|
+
|
|
186
|
+
```mermaid
|
|
187
|
+
classDiagram
|
|
188
|
+
class Order {
|
|
189
|
+
OrderId id
|
|
190
|
+
CustomerId customerId
|
|
191
|
+
OrderStatus status
|
|
192
|
+
Money total
|
|
193
|
+
ShippingAddress destination
|
|
194
|
+
place()
|
|
195
|
+
confirm(paymentId)
|
|
196
|
+
cancel(reason)
|
|
197
|
+
ship(trackingId)
|
|
198
|
+
deliver()
|
|
199
|
+
}
|
|
200
|
+
class OrderItem {
|
|
201
|
+
ProductId productId
|
|
202
|
+
int quantity
|
|
203
|
+
Money unitPrice
|
|
204
|
+
Money lineTotal()
|
|
205
|
+
}
|
|
206
|
+
class Customer {
|
|
207
|
+
CustomerId id
|
|
208
|
+
EmailAddress email
|
|
209
|
+
PersonName name
|
|
210
|
+
}
|
|
211
|
+
class ShippingAddress {
|
|
212
|
+
string street
|
|
213
|
+
string city
|
|
214
|
+
string country
|
|
215
|
+
string postalCode
|
|
216
|
+
}
|
|
217
|
+
class Money {
|
|
218
|
+
decimal amount
|
|
219
|
+
string currency
|
|
220
|
+
add(Money)
|
|
221
|
+
multiply(int)
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
Order "1" *-- "1..*" OrderItem : contains
|
|
225
|
+
Order "1" *-- "1" ShippingAddress : ships to
|
|
226
|
+
Order "*" --> "1" Customer : placed by
|
|
227
|
+
OrderItem --> Money : priced in
|
|
228
|
+
Order --> Money : totals to
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
```text
|
|
232
|
+
[Customer] <--- (placed by) ---* [Order] *--- (ships to) ---> [ShippingAddress]
|
|
233
|
+
| *
|
|
234
|
+
(contains)
|
|
235
|
+
|
|
|
236
|
+
[OrderItem]
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
---
|
|
240
|
+
|
|
241
|
+
## Known Domain Complexities
|
|
242
|
+
|
|
243
|
+
Document areas of the domain that are inherently complex or contentious:
|
|
244
|
+
|
|
245
|
+
| Area | Complexity | Notes |
|
|
246
|
+
|---|---|---|
|
|
247
|
+
| [Pricing] | HIGH | [Multiple discount types can apply; tax varies by jurisdiction; currency conversion needed] |
|
|
248
|
+
| [Inventory] | MEDIUM | [Reservations vs actual deductions; multi-warehouse scenarios] |
|
|
249
|
+
| [Order state transitions] | MEDIUM | [Partial cancellation rules; return vs refund distinction] |
|
|
250
|
+
|
|
251
|
+
---
|
|
252
|
+
|
|
253
|
+
*Domain model reviewed with: [list domain experts consulted]*
|
|
254
|
+
*Next review: [when major business rule changes, or every 6 months]*
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# Architecture Fitness Functions: [System / Service Name]
|
|
2
|
+
|
|
3
|
+
**Date:** [YYYY-MM-DD]
|
|
4
|
+
**Owner:** [name or role]
|
|
5
|
+
**Status:** Draft | Active | Deprecated
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 1. Purpose
|
|
10
|
+
|
|
11
|
+
<!-- A fitness function is an OBJECTIVE, executable test that some architectural
|
|
12
|
+
characteristic stays within bounds as the system evolves. If it can't be
|
|
13
|
+
measured, it isn't a fitness function — it's a wish. -->
|
|
14
|
+
|
|
15
|
+
This document defines the automated guardrails that protect the architectural
|
|
16
|
+
characteristics ("-ilities") of [System Name]. Each one is a test that fails
|
|
17
|
+
loudly when an architectural quality regresses.
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## 2. Fitness Function Register
|
|
22
|
+
|
|
23
|
+
Type key: **atomic** = tests one characteristic in isolation; **holistic** = tests several interacting; **triggered** = runs on demand/PR; **continuous** = runs always (e.g. in prod monitoring).
|
|
24
|
+
|
|
25
|
+
| # | Architectural characteristic | Fitness function (objective test) | Type (atomic/holistic, triggered/continuous) | Threshold | CI wiring | Owner |
|
|
26
|
+
|---|---|---|---|---|---|---|
|
|
27
|
+
| 1 | [e.g. Modularity] | [Objective, runnable check] | [atomic, triggered] | [Pass/fail bound] | [Where it runs] | [Who] |
|
|
28
|
+
| 2 | [ ] | [ ] | [ ] | [ ] | [ ] | [ ] |
|
|
29
|
+
| 3 | [ ] | [ ] | [ ] | [ ] | [ ] | [ ] |
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## 3. Worked Examples
|
|
34
|
+
|
|
35
|
+
### Example A — Layering rule (atomic, triggered)
|
|
36
|
+
- **Characteristic:** Maintainability / enforced layering.
|
|
37
|
+
- **Test:** "The `web` package must not import from the `persistence` package directly." Enforced with a dependency-rule tool (e.g. ArchUnit, import-linter, dependency-cruiser).
|
|
38
|
+
- **Threshold:** Zero violations.
|
|
39
|
+
- **CI wiring:** Runs on every pull request; build fails on any violation.
|
|
40
|
+
|
|
41
|
+
### Example B — Cyclomatic complexity limit (atomic, triggered)
|
|
42
|
+
- **Characteristic:** Readability / testability.
|
|
43
|
+
- **Test:** Static analysis reports cyclomatic complexity per function.
|
|
44
|
+
- **Threshold:** No function may exceed a complexity of [N]; offenders block merge.
|
|
45
|
+
- **CI wiring:** Linter step in the PR pipeline.
|
|
46
|
+
|
|
47
|
+
### Example C — Latency budget (holistic, continuous)
|
|
48
|
+
- **Characteristic:** Performance.
|
|
49
|
+
- **Test:** p99 latency of the `[endpoint]` measured against synthetic load.
|
|
50
|
+
- **Threshold:** p99 < [X] ms at [Y] RPS.
|
|
51
|
+
- **CI wiring:** Nightly load test + continuous production SLO monitor that pages on breach.
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## 4. Governance
|
|
56
|
+
|
|
57
|
+
**Review cadence:** [How often the register is revisited, e.g. quarterly.]
|
|
58
|
+
**On failure:** [Block merge / page on-call / open ticket — define per severity.]
|
|
59
|
+
**Adding a new function:** [Who approves, where it lives, how it's wired.]
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Integration Specification: [Integration Name]
|
|
2
|
+
|
|
3
|
+
**Type**: [Inbound / Outbound / Bi-directional]
|
|
4
|
+
**External System**: [Salesforce / SAP / Stripe / Partner API]
|
|
5
|
+
**Protocol**: [REST / SOAP / FTP / Queue]
|
|
6
|
+
|
|
7
|
+
## 1. Business Context
|
|
8
|
+
[Why are we integrating? What value does this provide?]
|
|
9
|
+
|
|
10
|
+
## 2. Data Mapping
|
|
11
|
+
| Our Field | External Field | Transformation Rules |
|
|
12
|
+
|---|---|---|
|
|
13
|
+
| `user.email` | `Contact.Email` | Lowercase |
|
|
14
|
+
| `user.id` | `Contact.ExternalId__c` | |
|
|
15
|
+
| `order.status` | `Opportunity.StageName` | Map: Paid -> Closed Won |
|
|
16
|
+
|
|
17
|
+
## 3. Integration Pattern
|
|
18
|
+
- **Pattern**: [Real-time / Batch / Event-Driven]
|
|
19
|
+
- **Trigger**: [User Action / Nightly Job / Webhook]
|
|
20
|
+
- **Direction**: [Push to External / Pull from External]
|
|
21
|
+
|
|
22
|
+
## 4. Authentication & Security
|
|
23
|
+
- **Method**: [OAuth2 / API Key / mTLS / VPN]
|
|
24
|
+
- **Credentials**: [Stored in Secrets Manager]
|
|
25
|
+
- **Network**: [Whitelisting IPs required?]
|
|
26
|
+
|
|
27
|
+
## 5. Resilience & Performance
|
|
28
|
+
- **Rate Limits**: [External system limit: 100 req/min]
|
|
29
|
+
- **Throttling**: [Our implementation: Max 80 req/min]
|
|
30
|
+
- **Retry Policy**: [Exp. backoff up to 1 hour]
|
|
31
|
+
- **Circuit Breaker**: [Trip after 50% errors in 1 min]
|
|
32
|
+
|
|
33
|
+
## 6. Error Handling
|
|
34
|
+
| Error Scenario | Action | Alert |
|
|
35
|
+
|---|---|---|
|
|
36
|
+
| Auth Failure | Stop & Alert | P1 |
|
|
37
|
+
| Validation Error | Log to DLQ | P3 |
|
|
38
|
+
| Timeout | Retry (3x) | - |
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Legacy System Audit: [System Name]
|
|
2
|
+
|
|
3
|
+
**Language**: [COBOL / Fortran / VB6 / Delphi]
|
|
4
|
+
**Age**: [X Years]
|
|
5
|
+
**Criticality**: [High - $XM/day flows through this]
|
|
6
|
+
|
|
7
|
+
## 1. Knowledge Risk (Bus Factor)
|
|
8
|
+
- **Who knows how this works?**: [Name(s) / "No one"]
|
|
9
|
+
- **Documentation Status**: [None / Outdated / Good]
|
|
10
|
+
- **Bus Factor Score**: [1-5 (1 = Only one person knows)]
|
|
11
|
+
|
|
12
|
+
## 2. Technical Health
|
|
13
|
+
- **Source Code Availability**: [Yes / Partial / Lost (Binary only)]
|
|
14
|
+
- **Build Process**: [Automated / Manual Scripts / "Don't touch it"]
|
|
15
|
+
- **Test Coverage**: [None / Manual / Automated Unit Tests]
|
|
16
|
+
- **Database**: [DB2 / VSAM / Flat Files / Oracle 8i]
|
|
17
|
+
|
|
18
|
+
## 3. Coupling Analysis
|
|
19
|
+
- **Inbound Dependencies**: [Who calls us?]
|
|
20
|
+
- **Outbound Dependencies**: [Who do we call?]
|
|
21
|
+
- **Hard Dependencies**: [Mainframe hardware / Specific OS version]
|
|
22
|
+
|
|
23
|
+
## 4. Modernization Strategy
|
|
24
|
+
**Selected Strategy**: [Retain / Encapsulate / Refactor / Replatform]
|
|
25
|
+
|
|
26
|
+
### Phase 1: Stabilization
|
|
27
|
+
- [ ] Create "Golden Master" test suite (capture I/O)
|
|
28
|
+
- [ ] Dockerize build environment (if possible)
|
|
29
|
+
- [ ] Document core business rules
|
|
30
|
+
|
|
31
|
+
### Phase 2: Strangulation (Optional)
|
|
32
|
+
- [ ] Identify first slice to migrate (e.g., "Customer Lookup")
|
|
33
|
+
- [ ] Build Anti-Corruption Layer (ACL)
|
|
34
|
+
- [ ] Route traffic to new service
|
|
@@ -0,0 +1,210 @@
|
|
|
1
|
+
# Quality Attributes — [System Name]
|
|
2
|
+
<!-- Quality Attribute Scenarios (QAS) using SEI/Carnegie Mellon format -->
|
|
3
|
+
<!-- Created by: arch-design.skill, req-elicitation.skill -->
|
|
4
|
+
<!-- Referenced by: ARCHITECTURE_VIEWS_TEMPLATE.md, ARCHITECTURE_REVIEW_TEMPLATE.md -->
|
|
5
|
+
<!-- Standard: ISO/IEC 25010 (SQuaRE) quality model -->
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Meta
|
|
10
|
+
|
|
11
|
+
| Field | Value |
|
|
12
|
+
|---|---|
|
|
13
|
+
| **System** | [system name] |
|
|
14
|
+
| **Version** | [1.0] |
|
|
15
|
+
| **Date** | [YYYY-MM-DD] |
|
|
16
|
+
| **Status** | DRAFT / APPROVED |
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## Quality Attribute Priority
|
|
21
|
+
|
|
22
|
+
Rank the top quality attributes for this system (drives architecture decisions):
|
|
23
|
+
|
|
24
|
+
| Priority | Quality Attribute | Business Justification |
|
|
25
|
+
|---|---|---|
|
|
26
|
+
| 1 | [e.g., Reliability] | [e.g., Downtime directly causes revenue loss] |
|
|
27
|
+
| 2 | [e.g., Security] | [e.g., Handles financial data; breach is existential risk] |
|
|
28
|
+
| 3 | [e.g., Performance] | [e.g., Users abandon if response > 3s] |
|
|
29
|
+
| 4 | [e.g., Maintainability] | [e.g., Small team, frequent feature additions] |
|
|
30
|
+
| 5 | [e.g., Usability] | [e.g., Non-technical end users] |
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
## Quality Attribute Scenarios (QAS)
|
|
35
|
+
|
|
36
|
+
Each QAS has 6 components:
|
|
37
|
+
- **Source**: Who or what generates the stimulus
|
|
38
|
+
- **Stimulus**: The event or condition
|
|
39
|
+
- **Environment**: Operating conditions when stimulus occurs
|
|
40
|
+
- **Artifact**: What part of the system is stimulated
|
|
41
|
+
- **Response**: System's reaction
|
|
42
|
+
- **Measure**: How we know the response is acceptable (quantified)
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
### Performance Scenarios
|
|
47
|
+
|
|
48
|
+
#### QAS-P01: [Scenario Name]
|
|
49
|
+
|
|
50
|
+
| Component | Value |
|
|
51
|
+
|---|---|
|
|
52
|
+
| **Source** | [e.g., 1,000 concurrent authenticated users] |
|
|
53
|
+
| **Stimulus** | [e.g., Each submits a search query simultaneously] |
|
|
54
|
+
| **Environment** | [e.g., Normal operating conditions, peak load period] |
|
|
55
|
+
| **Artifact** | [e.g., Search component and database] |
|
|
56
|
+
| **Response** | [e.g., System processes all queries and returns results] |
|
|
57
|
+
| **Measure** | [e.g., p99 response time < 2 seconds; no queries dropped] |
|
|
58
|
+
|
|
59
|
+
**Priority**: MUST / SHOULD / COULD
|
|
60
|
+
**Architectural implication**: [What design decisions does this drive?]
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
#### QAS-P02: [Scenario Name]
|
|
65
|
+
|
|
66
|
+
| Component | Value |
|
|
67
|
+
|---|---|
|
|
68
|
+
| **Source** | |
|
|
69
|
+
| **Stimulus** | |
|
|
70
|
+
| **Environment** | |
|
|
71
|
+
| **Artifact** | |
|
|
72
|
+
| **Response** | |
|
|
73
|
+
| **Measure** | |
|
|
74
|
+
|
|
75
|
+
**Priority**:
|
|
76
|
+
**Architectural implication**:
|
|
77
|
+
|
|
78
|
+
---
|
|
79
|
+
|
|
80
|
+
### Reliability Scenarios
|
|
81
|
+
|
|
82
|
+
#### QAS-R01: [Scenario Name]
|
|
83
|
+
|
|
84
|
+
| Component | Value |
|
|
85
|
+
|---|---|
|
|
86
|
+
| **Source** | [e.g., Primary database server] |
|
|
87
|
+
| **Stimulus** | [e.g., Hardware failure — server becomes unresponsive] |
|
|
88
|
+
| **Environment** | [e.g., Normal operation, no planned maintenance] |
|
|
89
|
+
| **Artifact** | [e.g., Data persistence layer] |
|
|
90
|
+
| **Response** | [e.g., System fails over to replica; in-flight transactions recovered] |
|
|
91
|
+
| **Measure** | [e.g., Recovery time < 30 seconds; zero data loss for committed transactions] |
|
|
92
|
+
|
|
93
|
+
**Priority**: MUST / SHOULD / COULD
|
|
94
|
+
**Architectural implication**: [Requires active-passive replica, automatic failover]
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
#### QAS-R02: Availability Target
|
|
99
|
+
|
|
100
|
+
| Component | Value |
|
|
101
|
+
|---|---|
|
|
102
|
+
| **Source** | [Monitoring system] |
|
|
103
|
+
| **Stimulus** | [Measuring system uptime over a calendar month] |
|
|
104
|
+
| **Environment** | [Normal operation including deployments] |
|
|
105
|
+
| **Artifact** | [Entire system] |
|
|
106
|
+
| **Response** | [System is available and responding correctly] |
|
|
107
|
+
| **Measure** | [99.9% availability = max 43.8 min downtime/month] |
|
|
108
|
+
|
|
109
|
+
**Priority**:
|
|
110
|
+
**Architectural implication**:
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
### Security Scenarios
|
|
115
|
+
|
|
116
|
+
#### QAS-S01: [Scenario Name]
|
|
117
|
+
|
|
118
|
+
| Component | Value |
|
|
119
|
+
|---|---|
|
|
120
|
+
| **Source** | [e.g., External attacker] |
|
|
121
|
+
| **Stimulus** | [e.g., Attempts SQL injection via search form input] |
|
|
122
|
+
| **Environment** | [e.g., Normal operation, public-facing endpoint] |
|
|
123
|
+
| **Artifact** | [e.g., Input validation layer, database query layer] |
|
|
124
|
+
| **Response** | [e.g., Input rejected; malicious query never reaches database; attack logged] |
|
|
125
|
+
| **Measure** | [e.g., Zero successful SQL injections; attack attempt logged with source IP within 1s] |
|
|
126
|
+
|
|
127
|
+
**Priority**:
|
|
128
|
+
**Architectural implication**:
|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
### Usability Scenarios
|
|
133
|
+
|
|
134
|
+
#### QAS-U01: [Scenario Name]
|
|
135
|
+
|
|
136
|
+
| Component | Value |
|
|
137
|
+
|---|---|
|
|
138
|
+
| **Source** | [e.g., First-time user with no training] |
|
|
139
|
+
| **Stimulus** | [e.g., Attempts to complete [core task] for the first time] |
|
|
140
|
+
| **Environment** | [e.g., Production system, no assistance available] |
|
|
141
|
+
| **Artifact** | [e.g., User interface] |
|
|
142
|
+
| **Response** | [e.g., User successfully completes task] |
|
|
143
|
+
| **Measure** | [e.g., Task completed correctly in < 5 minutes by 99% of test users] |
|
|
144
|
+
|
|
145
|
+
**Priority**:
|
|
146
|
+
**Architectural implication**:
|
|
147
|
+
|
|
148
|
+
---
|
|
149
|
+
|
|
150
|
+
### Maintainability Scenarios
|
|
151
|
+
|
|
152
|
+
#### QAS-M01: [Scenario Name]
|
|
153
|
+
|
|
154
|
+
| Component | Value |
|
|
155
|
+
|---|---|
|
|
156
|
+
| **Source** | [e.g., Developer] |
|
|
157
|
+
| **Stimulus** | [e.g., Needs to add a new payment method to the system] |
|
|
158
|
+
| **Environment** | [e.g., Development environment, existing codebase] |
|
|
159
|
+
| **Artifact** | [e.g., Payment module] |
|
|
160
|
+
| **Response** | [e.g., Developer adds new payment method by implementing one interface] |
|
|
161
|
+
| **Measure** | [e.g., Change confined to ≤ 3 files; no existing tests break; feature complete in < 1 day] |
|
|
162
|
+
|
|
163
|
+
**Priority**:
|
|
164
|
+
**Architectural implication**:
|
|
165
|
+
|
|
166
|
+
---
|
|
167
|
+
|
|
168
|
+
### Additional Quality Attributes
|
|
169
|
+
|
|
170
|
+
Add more QAS for: Portability, Compatibility, Interoperability, Scalability (as needed)
|
|
171
|
+
|
|
172
|
+
#### QAS-NNN: [Scenario Name]
|
|
173
|
+
|
|
174
|
+
| Component | Value |
|
|
175
|
+
|---|---|
|
|
176
|
+
| **Source** | |
|
|
177
|
+
| **Stimulus** | |
|
|
178
|
+
| **Environment** | |
|
|
179
|
+
| **Artifact** | |
|
|
180
|
+
| **Response** | |
|
|
181
|
+
| **Measure** | |
|
|
182
|
+
|
|
183
|
+
**Priority**:
|
|
184
|
+
**Architectural implication**:
|
|
185
|
+
|
|
186
|
+
---
|
|
187
|
+
|
|
188
|
+
## QAS Summary (for Architecture Validation)
|
|
189
|
+
|
|
190
|
+
| ID | Quality Attribute | Priority | Measure | Satisfied by Architecture? |
|
|
191
|
+
|---|---|---|---|---|
|
|
192
|
+
| QAS-P01 | Performance | MUST | p99 < 2s under 1k users | [YES/AT RISK/NO — after arch review] |
|
|
193
|
+
| QAS-R01 | Reliability | MUST | Recovery < 30s, zero data loss | |
|
|
194
|
+
| QAS-R02 | Availability | MUST | 99.9% monthly | |
|
|
195
|
+
| QAS-S01 | Security | MUST | Zero SQL injections | |
|
|
196
|
+
| QAS-U01 | Usability | SHOULD | Task in < 5min | |
|
|
197
|
+
| QAS-M01 | Maintainability | SHOULD | New payment type in 1 day | |
|
|
198
|
+
|
|
199
|
+
---
|
|
200
|
+
|
|
201
|
+
## Fitness Functions
|
|
202
|
+
|
|
203
|
+
For each MUST QAS, define how it will be continuously measured:
|
|
204
|
+
|
|
205
|
+
| QAS | Fitness Function | Measurement Tool | Frequency |
|
|
206
|
+
|---|---|---|---|
|
|
207
|
+
| QAS-P01 | Load test response time | k6 or Gatling | Every release |
|
|
208
|
+
| QAS-R01 | Chaos test — kill DB | Chaos Monkey / manual | Quarterly |
|
|
209
|
+
| QAS-R02 | Uptime monitoring | Grafana + alerting | Continuous |
|
|
210
|
+
| QAS-S01 | OWASP ZAP scan | CI pipeline | Every PR |
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Scalability Analysis & Architecture Plan
|
|
2
|
+
|
|
3
|
+
**System / Component:** [System Name]
|
|
4
|
+
**Date:** [YYYY-MM-DD]
|
|
5
|
+
**Auditor / Agent:** [Agent Name or User]
|
|
6
|
+
|
|
7
|
+
## 1. Executive Summary
|
|
8
|
+
[High-level summary of the current bottleneck and the proposed scaling strategy]
|
|
9
|
+
|
|
10
|
+
## 2. Current Capacity Baseline
|
|
11
|
+
| Metric | Current Value | Threshold of Pain |
|
|
12
|
+
| :--- | :--- | :--- |
|
|
13
|
+
| **Requests / Sec (Peak)** | | |
|
|
14
|
+
| **Database Ops / Sec** | | |
|
|
15
|
+
| **Compute Util (Avg %)** | | |
|
|
16
|
+
| **Memory Util (Avg %)** | | |
|
|
17
|
+
| **Network I/O** | | |
|
|
18
|
+
|
|
19
|
+
## 3. Bottleneck Identification
|
|
20
|
+
* **Layer:** (e.g., Database Write, App Server CPU, Network Bandwidth)
|
|
21
|
+
* **Root Cause:** [Explain why this layer constraints growth]
|
|
22
|
+
|
|
23
|
+
## 4. Scaling Strategy Proposal
|
|
24
|
+
|
|
25
|
+
### 4.1 Application Layer
|
|
26
|
+
* [ ] **Vertical (Scale Up)**: [Rationale / Hardware specs]
|
|
27
|
+
* [ ] **Horizontal (Scale Out)**: [Node count, Auto-Scaling thresholds]
|
|
28
|
+
* **State Management**: [How session state is handled, e.g., migrated to Redis]
|
|
29
|
+
|
|
30
|
+
### 4.2 Data Layer
|
|
31
|
+
* [ ] **Read Replicas**: [Configuration]
|
|
32
|
+
* [ ] **Sharding**: [Sharding Key Strategy (Hash/Range) & Logic]
|
|
33
|
+
* [ ] **Partitioning**: [Table partitioning logic]
|
|
34
|
+
* [ ] **Caching**: [Memcached/Redis implementation]
|
|
35
|
+
|
|
36
|
+
## 5. Risk Assessment (The "Cost" of Scaling)
|
|
37
|
+
| Risk | Probability | Mitigation |
|
|
38
|
+
| :--- | :--- | :--- |
|
|
39
|
+
| FinOps Cost Explosion | High | Set hard billing limits & HPA max counts |
|
|
40
|
+
| Shared State Collision | Medium | Implement Optimistic Concurrency Control |
|
|
41
|
+
| Split-Brain (Replication) | Low | Quorum-based consensus (Raft/Paxos) |
|
|
42
|
+
|
|
43
|
+
## 6. Implementation Milestones
|
|
44
|
+
1. [Milestone 1: Externalize state]
|
|
45
|
+
2. [Milestone 2: Implement Read Replicas]
|
|
46
|
+
3. [Milestone 3: Auto-scaling App Servers]
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Smart Contract & DLT Architecture Template
|
|
2
|
+
|
|
3
|
+
**Contract/System Name:** [System Name]
|
|
4
|
+
**Network / Protocol:** [e.g., Ethereum Mainnet, Hyperledger Fabric, Polygon]
|
|
5
|
+
**Author / Auditor:** [Name / Agent]
|
|
6
|
+
|
|
7
|
+
## 1. System Overview
|
|
8
|
+
[Describe the business logic this distributed ledger aims to solve. Why is a blockchain needed here instead of a traditional database?]
|
|
9
|
+
|
|
10
|
+
## 2. Architecture & Components
|
|
11
|
+
|
|
12
|
+
### 2.1 On-Chain Logic (Smart Contracts)
|
|
13
|
+
- **Primary Contract(s)**: [List main contracts and their responsibilities]
|
|
14
|
+
- **State Variables**: [Which variables are stored permanently on-chain?]
|
|
15
|
+
- **Events**: [What events are emitted for off-chain listeners?]
|
|
16
|
+
|
|
17
|
+
### 2.2 Upgradeability Pattern
|
|
18
|
+
- [ ] Immutable (Deploy once, no changes)
|
|
19
|
+
- [ ] Proxy Pattern (Transparent / UUPS)
|
|
20
|
+
- [ ] Diamond Pattern (EIP-2535)
|
|
21
|
+
*Rationale:* [Explain the choice]
|
|
22
|
+
|
|
23
|
+
### 2.3 Off-Chain Integration (Oracles & App Layer)
|
|
24
|
+
- **Oracles**: [How does real-world data enter the blockchain? e.g., Chainlink]
|
|
25
|
+
- **Indexing**: [How is data queried? e.g., The Graph, custom backend indexer]
|
|
26
|
+
- **Wallet / Auth**: [MetaMask, WalletConnect, Enterprise Custodial Wallet]
|
|
27
|
+
|
|
28
|
+
## 3. Security Analysis (Critical)
|
|
29
|
+
|
|
30
|
+
| Vulnerability Category | Mitigation Strategy in Code |
|
|
31
|
+
| :--- | :--- |
|
|
32
|
+
| **Reentrancy** | E.g., Use Checks-Effects-Interactions pattern & `nonReentrant` modifier |
|
|
33
|
+
| **Access Control** | E.g., OpenZeppelin `Ownable` or `AccessControl` roles |
|
|
34
|
+
| **Front-Running (MEV)** | [Mitigation logic] |
|
|
35
|
+
| **Logic Errors / Math** | E.g., Rely on Solidity ^0.8.0 built-in overflow protection |
|
|
36
|
+
|
|
37
|
+
## 4. Gas & Performance Optimization
|
|
38
|
+
- [List specific decisions made to keep transaction costs (gas) low, e.g., tightly packing structs, avoiding loops over unbounded arrays.]
|
|
39
|
+
|
|
40
|
+
## 5. Deployment & Testing Plan
|
|
41
|
+
1. **Local Testnet**: [Hardhat / Foundry / Ganache]
|
|
42
|
+
2. **Test Coverage Target**: [e.g., 100% Branch Coverage]
|
|
43
|
+
3. **Public Testnet (e.g., Sepolia)**: [Target Date]
|
|
44
|
+
4. **Third-Party Security Audit**: [Requirement before Mainnet]
|