agentic-data-stack-community
Version:
AI Agentic Data Stack Framework - Community Edition. Open source data engineering framework with 4 core agents, essential templates, and 3-dimensional quality validation.
338 lines (292 loc) • 11.2 kB
YAML
# Business Requirements Template
# Standardized template for capturing and documenting business requirements across the AI Agentic Data Stack Framework
metadata:
template_id: "business-requirements-tmpl"
name: "Business Requirements Template"
version: "1.0.0"
description: "Comprehensive template for gathering, documenting, and managing business requirements for data initiatives"
category: "business-process"
tags: ["requirements", "business", "stakeholders", "analysis", "documentation"]
created_by: "AI Agentic Data Stack Framework"
created_date: "2025-01-23"
template:
name: "Business Requirements Template"
description: "Template for business requirements implementation and management"
version: "1.0.0"
# Requirements Configuration
requirements_config:
requirement_id: "${requirement_id}"
requirement_name: "${requirement_name}"
description: "${requirement_description}"
version: "${requirement_version}"
priority: "${requirement_priority}" # critical, high, medium, low
status: "${requirement_status}" # draft, approved, implemented, deprecated
# Business Context
business_context:
business_domain: "${business_domain}"
business_process: "${business_process}"
business_objective: "${business_objective}"
success_criteria: ["${success_criteria}"]
business_value: "${expected_business_value}"
stakeholder_impact: ["${stakeholder_impact}"]
# Stakeholder Information
stakeholders:
# Business Sponsor
business_sponsor:
name: "${sponsor_name}"
role: "${sponsor_role}"
department: "${sponsor_department}"
contact: "${sponsor_contact}"
# Primary Users
primary_users:
- user_id: "${user_id}"
name: "${user_name}"
role: "${user_role}"
department: "${user_department}"
usage_frequency: "${usage_frequency}"
technical_proficiency: "${technical_proficiency}"
# Subject Matter Experts
subject_matter_experts:
- expert_id: "${expert_id}"
name: "${expert_name}"
expertise_area: "${expertise_area}"
involvement_level: "${involvement_level}"
# Functional Requirements
functional_requirements:
- requirement_id: "${functional_req_id}"
requirement_type: "functional"
requirement_statement: "${functional_requirement_statement}"
acceptance_criteria: ["${acceptance_criteria}"]
business_rules: ["${business_rules}"]
data_dependencies: ["${data_dependencies}"]
priority: "${functional_priority}"
# Non-Functional Requirements
non_functional_requirements:
# Performance Requirements
performance:
- metric: "response_time"
target_value: "${response_time_target}"
measurement_method: "${response_time_measurement}"
- metric: "throughput"
target_value: "${throughput_target}"
measurement_method: "${throughput_measurement}"
# Scalability Requirements
scalability:
- metric: "concurrent_users"
target_value: ${max_concurrent_users}
growth_projection: "${user_growth_projection}"
- metric: "data_volume"
current_volume: "${current_data_volume}"
projected_volume: "${projected_data_volume}"
# Availability Requirements
availability:
uptime_requirement: "${uptime_requirement}"
planned_downtime: "${planned_downtime_window}"
disaster_recovery_time: "${disaster_recovery_time}"
# Security Requirements
security:
authentication_method: "${required_authentication}"
authorization_model: "${required_authorization}"
data_encryption: "${encryption_requirements}"
compliance_standards: ["${compliance_requirements}"]
# Data Requirements
data_requirements:
# Data Sources
data_sources:
- source_id: "${data_source_id}"
source_name: "${data_source_name}"
source_type: "${source_type}"
data_category: "${data_category}"
update_frequency: "${data_update_frequency}"
data_quality_requirements: ["${quality_requirements}"]
# Data Outputs
data_outputs:
- output_id: "${data_output_id}"
output_name: "${data_output_name}"
output_format: "${output_format}"
delivery_method: "${delivery_method}"
frequency: "${output_frequency}"
# Data Transformations
data_transformations:
- transformation_id: "${transformation_id}"
transformation_description: "${transformation_description}"
business_logic: "${transformation_business_logic}"
validation_rules: ["${transformation_validation_rules}"]
# Integration Requirements
integration_requirements:
# System Integrations
system_integrations:
- system_id: "${integration_system_id}"
system_name: "${integration_system_name}"
integration_type: "${integration_type}" # real_time, batch, api
data_flow_direction: "${data_flow_direction}" # inbound, outbound, bidirectional
# API Requirements
api_requirements:
- api_endpoint: "${required_api_endpoint}"
api_method: "${api_method}"
authentication: "${api_authentication}"
data_format: "${api_data_format}"
# File Integration
file_integrations:
- file_type: "${file_type}"
file_location: "${file_location}"
processing_frequency: "${file_processing_frequency}"
# User Experience Requirements
user_experience_requirements:
# Interface Requirements
interface_requirements:
user_interface_type: "${ui_type}" # web, mobile, desktop, api
accessibility_standards: ["${accessibility_standards}"]
browser_compatibility: ["${browser_compatibility}"]
# Usability Requirements
usability_requirements:
ease_of_use: "${usability_target}"
training_requirements: "${training_requirements}"
help_documentation: "${help_documentation_requirements}"
# Reporting Requirements
reporting_requirements:
- report_id: "${report_id}"
report_name: "${report_name}"
report_type: "${report_type}"
frequency: "${report_frequency}"
distribution: ["${report_distribution}"]
# Constraints and Assumptions
constraints_assumptions:
# Technical Constraints
technical_constraints:
- constraint_id: "${technical_constraint_id}"
constraint_description: "${technical_constraint_description}"
impact: "${constraint_impact}"
mitigation: "${constraint_mitigation}"
# Business Constraints
business_constraints:
- constraint_id: "${business_constraint_id}"
constraint_description: "${business_constraint_description}"
rationale: "${constraint_rationale}"
# Budget Constraints
budget_constraints:
total_budget: "${total_project_budget}"
budget_breakdown: ["${budget_breakdown}"]
funding_source: "${funding_source}"
# Time Constraints
time_constraints:
project_deadline: "${project_deadline}"
key_milestones: ["${key_milestones}"]
dependencies: ["${timeline_dependencies}"]
# Assumptions
assumptions:
- assumption_id: "${assumption_id}"
assumption_description: "${assumption_description}"
validation_method: "${assumption_validation}"
risk_if_invalid: "${assumption_risk}"
# Risk Assessment
risk_assessment:
# Identified Risks
risks:
- risk_id: "${risk_id}"
risk_description: "${risk_description}"
risk_category: "${risk_category}" # technical, business, regulatory, resource
probability: "${risk_probability}" # high, medium, low
impact: "${risk_impact}" # high, medium, low
mitigation_strategy: "${risk_mitigation}"
owner: "${risk_owner}"
# Risk Matrix
risk_matrix:
high_probability_high_impact: ["${high_high_risks}"]
high_probability_medium_impact: ["${high_medium_risks}"]
medium_probability_high_impact: ["${medium_high_risks}"]
# Success Metrics
success_metrics:
# Business Metrics
business_metrics:
- metric_name: "${business_metric_name}"
metric_description: "${business_metric_description}"
target_value: "${business_metric_target}"
measurement_method: "${business_metric_measurement}"
# Technical Metrics
technical_metrics:
- metric_name: "${technical_metric_name}"
metric_description: "${technical_metric_description}"
target_value: "${technical_metric_target}"
measurement_frequency: "${technical_metric_frequency}"
# User Satisfaction Metrics
user_satisfaction_metrics:
- metric_name: "${satisfaction_metric_name}"
measurement_method: "${satisfaction_measurement_method}"
target_score: "${satisfaction_target_score}"
# Validation and Approval
validation_approval:
# Review Process
review_process:
review_stages: ["${review_stages}"]
reviewers: ["${requirement_reviewers}"]
approval_criteria: ["${approval_criteria}"]
# Validation Methods
validation_methods:
- validation_type: "${validation_type}" # prototype, walkthrough, inspection
validation_description: "${validation_description}"
participants: ["${validation_participants}"]
# Approval Workflow
approval_workflow:
approval_sequence: ["${approval_sequence}"]
final_approver: "${final_approver}"
approval_documentation: "${approval_documentation_location}"
# Change Management
change_management:
# Change Control Process
change_control:
change_request_process: "${change_request_process}"
impact_assessment_required: ${impact_assessment_required}
approval_authority: "${change_approval_authority}"
# Version Control
version_control:
versioning_strategy: "${requirements_versioning_strategy}"
change_history: ["${change_history}"]
baseline_management: "${baseline_management_approach}"
# Communication Plan
communication_plan:
stakeholder_notification: "${stakeholder_notification_method}"
change_communication_frequency: "${change_communication_frequency}"
# Traceability
traceability:
# Requirements Traceability
requirements_traceability:
parent_requirements: ["${parent_requirements}"]
child_requirements: ["${child_requirements}"]
related_requirements: ["${related_requirements}"]
# Design Traceability
design_traceability:
design_documents: ["${design_documents}"]
implementation_artifacts: ["${implementation_artifacts}"]
test_cases: ["${test_cases}"]
# Business Traceability
business_traceability:
business_objectives: ["${traced_business_objectives}"]
success_metrics: ["${traced_success_metrics}"]
stakeholder_needs: ["${traced_stakeholder_needs}"]
# Validation Rules
validation_rules:
required_fields:
- requirement_id
- requirement_name
- business_context
- stakeholders
- functional_requirements
# Template Metadata
template_metadata:
author: "AI Agentic Data Stack Framework"
maintainer: "Business Analyst"
last_updated: "2025-01-23"
sections:
- name: "requirements_overview"
description: "Business requirements overview"
required: true
- name: "functional_requirements"
description: "Functional requirements specification"
required: true
- name: "non_functional_requirements"
description: "Non-functional requirements"
required: true
- name: "acceptance_criteria"
description: "Acceptance criteria and validation"
required: true