Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
2d3380f
Initial plan
Copilot Nov 1, 2025
2c6ca3b
Fix HTML entities and modernize async-lazy-loading.md
Copilot Nov 1, 2025
de34787
Remove underscore prefixes from all C# markdown files
Copilot Nov 1, 2025
ff3daa1
Fix field initializer syntax in primary constructors
Copilot Nov 1, 2025
fc2932b
feat: Add best practices documentation for cloud architecture, data a…
visionarycoder Nov 1, 2025
72086d3
Merge branch 'copilot/update-csharp-examples-syntax' of https://githu…
visionarycoder Nov 1, 2025
d74b046
Remove obsolete project files for various snippets and add new CSharp…
visionarycoder Nov 1, 2025
c0cb9a8
Add searching, sorting, and string algorithms implementations
visionarycoder Nov 1, 2025
fd47c40
Add PostgreSQL + pgvector ML examples notebook for experiment trackin…
visionarycoder Nov 2, 2025
6104810
Add advanced topic modeling service with LDA, document clustering, an…
visionarycoder Nov 2, 2025
b7e01fb
Add comprehensive documentation for Orleans patterns
visionarycoder Nov 2, 2025
1187e67
Add initial project configuration files and settings
visionarycoder Nov 2, 2025
248d2be
Refactor project files to enable central package management and updat…
visionarycoder Nov 2, 2025
6241a08
visionarycoder Nov 2, 2025
e3c28d1
Refactor solution structure and reorganize projects
visionarycoder Nov 2, 2025
97c0158
Add factory design pattern documentation and implementation in C#
visionarycoder Nov 3, 2025
2b660cd
Refactor documentation for consistency and clarity
visionarycoder Nov 5, 2025
82898ca
Add .NET project files and implement Python data processing patterns
visionarycoder Nov 8, 2025
da27753
Implement comprehensive file operations and testing utilities in C#
visionarycoder Nov 9, 2025
8561891
Implement Abstract Factory and Adapter design patterns with cross-pla…
visionarycoder Nov 9, 2025
db0dfb0
Add ML database models and implement SQLite and Postgres providers
visionarycoder Nov 27, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
51 changes: 51 additions & 0 deletions .best-practices/cloud-architecture/ReadMe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Cloud Architecture Best Practices

## 1. Purpose

Deliver scalable, resilient, and cost-effective solutions in cloud environments.

## 2. Core Principles

- Design for failure
- Automate everything
- Use managed services where possible
- Optimize for cost and performance

## 3. Industry Standards & Frameworks

- AWS Well-Architected Framework
- Azure Cloud Adoption Framework
- Google Cloud Architecture Framework

## 4. Common Patterns

- Multi-region deployments
- Hybrid cloud
- Event-driven serverless

## 5. Anti-Patterns to Avoid

- Lift-and-shift without modernization
- Over-provisioning resources
- Ignoring shared responsibility model

## 6. Tooling & Ecosystem

- Terraform, Bicep, Pulumi
- Kubernetes, Service Mesh
- Cloud-native monitoring tools

## 7. Emerging Trends

- FinOps
- Sustainability-aware workloads
- Cloud-native AI services

## 8. Architecture Decision Guidance

- Choose multi-cloud only if business/regulatory needs demand it.
- Balance managed services vs. portability.

## 9. References

- [Azure CAF](https://learn.microsoft.com/azure/cloud-adoption-framework/)
51 changes: 51 additions & 0 deletions .best-practices/data-analytics/ReadMe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Data & Analytics Best Practices

## 1. Purpose

Enable data-driven decision-making and advanced analytics.

## 2. Core Principles

- Treat data as a product
- Ensure data quality and lineage
- Secure data at rest and in motion
- Enable self-service analytics

## 3. Industry Standards & Frameworks

- Data Mesh
- DAMA-DMBOK
- FAIR data principles

## 4. Common Patterns

- Data lakehouse
- Event streaming pipelines
- ELT with dbt

## 5. Anti-Patterns to Avoid

- Data silos
- ETL sprawl
- Ignoring governance

## 6. Tooling & Ecosystem

- Kafka, Pulsar
- Snowflake, BigQuery, Synapse
- dbt, Airflow

## 7. Emerging Trends

- Real-time analytics
- AI/ML integration
- Data contracts

## 8. Architecture Decision Guidance

- Use data mesh when scaling across domains.
- Balance central governance with federated ownership.

## 9. References

- [Data Mesh Principles](https://martinfowler.com/articles/data-mesh-principles.html)
51 changes: 51 additions & 0 deletions .best-practices/devops/ReadMe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# DevOps & Platform Engineering Best Practices

## 1. Purpose

Enable rapid, reliable, and repeatable delivery of software.

## 2. Core Principles

- Everything as code
- Continuous feedback loops
- Shift-left testing and security
- Immutable infrastructure

## 3. Industry Standards & Frameworks

- CALMS model
- GitOps
- SRE principles

## 4. Common Patterns

- CI/CD pipelines
- Blue/green and canary deployments
- Infrastructure as Code

## 5. Anti-Patterns to Avoid

- Manual deployments
- Snowflake servers
- Over-reliance on scripts without version control

## 6. Tooling & Ecosystem

- GitHub Actions, Azure DevOps, Jenkins
- ArgoCD, Flux
- Prometheus, Grafana

## 7. Emerging Trends

- Platform engineering teams
- Internal developer platforms (IDPs)
- Policy-as-code

## 8. Architecture Decision Guidance

- Standardize pipelines across teams.
- Invest in developer experience (DX).

## 9. References

- [Google SRE Book](https://sre.google/books/)
51 changes: 51 additions & 0 deletions .best-practices/integration/ReadMe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Integration & APIs Best Practices

## 1. Purpose

Enable interoperability and composability across systems.

## 2. Core Principles

- API-first design
- Loose coupling
- Backward compatibility
- Contract-first development

## 3. Industry Standards & Frameworks

- OpenAPI/Swagger
- AsyncAPI
- GraphQL spec

## 4. Common Patterns

- API Gateway
- Event-driven integration
- CQRS

## 5. Anti-Patterns to Avoid

- Point-to-point spaghetti integrations
- Breaking API changes without versioning
- Overloading APIs with business logic

## 6. Tooling & Ecosystem

- Kong, Apigee, Azure API Management
- Kafka, RabbitMQ
- GraphQL servers

## 7. Emerging Trends

- API monetization
- Event mesh
- gRPC adoption

## 8. Architecture Decision Guidance

- Use REST for broad compatibility, gRPC for high-performance internal services.
- Favor async messaging for decoupling.

## 9. References

- [AsyncAPI Initiative](https://www.asyncapi.com/)
50 changes: 50 additions & 0 deletions .best-practices/observability/ReadMe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Observability Best Practices

## 1. Purpose
Provide visibility into system health, performance, and reliability.

## 2. Core Principles

- Instrument everything
- Correlate logs, metrics, and traces
- Automate alerting and remediation
- Design for failure detection

## 3. Industry Standards & Frameworks

- OpenTelemetry
- SRE golden signals
- ITIL incident management

## 4. Common Patterns

- Centralized logging
- Distributed tracing
- Metrics dashboards

## 5. Anti-Patterns to Avoid

- Alert fatigue
- Logging without structure
- Monitoring only infrastructure, not business KPIs

## 6. Tooling & Ecosystem

- Prometheus, Grafana
- ELK/EFK stack
- Jaeger, Zipkin

## 7. Emerging Trends

- AIOps
- Continuous profiling
- Observability-as-code

## 8. Architecture Decision Guidance

- Define SLIs, SLOs, SLAs early.
- Balance observability depth with cost.

## 9. References

- [OpenTelemetry](https://opentelemetry.io/)
125 changes: 125 additions & 0 deletions .best-practices/radar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
# Solution Architect Radar (2025 Q4)

This radar provides a maturity view of industry best practices across specialties.
Use it to guide adoption, trials, and assessments, while avoiding outdated practices.

---

## Quadrant View

### ADOPT

- **Software Architecture**: VBD, DDD, Clean/Hexagonal Architecture, ADRs
- **Security**: Zero Trust, OWASP Top 10, centralized secrets management
- **Cloud**: Managed services, IaC (Terraform/Bicep)
- **DevOps**: GitOps, CI/CD pipelines, immutable infrastructure
- **Data**: Lakehouse, ELT with dbt, event streaming
- **Integration**: API-first, OpenAPI/AsyncAPI, backward-compatible versioning
- **Observability**: OpenTelemetry, SRE golden signals

### TRIAL

- **Software Architecture**: Event Sourcing, CQRS
- **Security**: Confidential computing, automated threat modeling
- **Cloud**: Serverless-first, multi-cloud portability frameworks
- **DevOps**: Internal Developer Platforms (IDPs), policy-as-code
- **Data**: Data mesh, real-time analytics
- **Integration**: GraphQL, gRPC
- **Observability**: Observability-as-code, continuous profiling

### ASSESS

- **Software Architecture**: AI-assisted validation, WASM backends
- **Security**: Post-quantum cryptography, AI-driven anomaly detection
- **Cloud**: Sustainability-aware workload placement
- **DevOps**: AI-driven pipeline optimization
- **Data**: Data contracts, AI-native governance
- **Integration**: Event mesh, API monetization
- **Observability**: AIOps-driven remediation, business KPI observability

### HOLD

- **Software Architecture**: Big Ball of Mud, God classes
- **Security**: Hardcoded secrets, perimeter-only defenses
- **Cloud**: Lift-and-shift without modernization
- **DevOps**: Manual deployments, snowflake servers
- **Data**: ETL sprawl, unmanaged silos
- **Integration**: Point-to-point spaghetti integrations
- **Observability**: Infra-only monitoring, unstructured logs

---

## Visual Radar (Mermaid)

```mermaid
flowchart LR
subgraph Q1 [ADOPT]
QA1[Software Architecture: DDD, Clean/Hexagonal, ADRs]
QA2[Security: Zero Trust, OWASP Top 10, Secrets mgmt]
QA3[Cloud: Managed services, IaC]
QA4[DevOps: GitOps, CI/CD, Immutable infra]
QA5[Data: Lakehouse, ELT with dbt, Event streaming]
QA6[Integration: API-first, OpenAPI/AsyncAPI, Versioning]
QA7[Observability: OpenTelemetry, SRE golden signals]
end

subgraph Q2 [TRIAL]
QT1[Software Architecture: Event Sourcing, CQRS]
QT2[Security: Confidential computing, Threat modeling automation]
QT3[Cloud: Serverless-first, Multi-cloud portability]
QT4[DevOps: IDPs, Policy-as-code]
QT5[Data: Data mesh, Real-time analytics]
QT6[Integration: GraphQL, gRPC]
QT7[Observability: Observability-as-code, Continuous profiling]
end

subgraph Q3 [ASSESS]
QS1[Software Architecture: AI-assisted validation, WASM backends]
QS2[Security: Post-quantum crypto, AI anomaly detection]
QS3[Cloud: Sustainability-aware placement]
QS4[DevOps: AI-driven pipeline optimization]
QS5[Data: Data contracts, AI-native governance]
QS6[Integration: Event mesh, API monetization]
QS7[Observability: AIOps remediation, Business KPI obs]
end

subgraph Q4 [HOLD]
QH1[Software Architecture: Big Ball of Mud, God classes]
QH2[Security: Hardcoded secrets, Perimeter-only]
QH3[Cloud: Lift-and-shift w/o modernization]
QH4[DevOps: Manual deployments, Snowflake servers]
QH5[Data: ETL sprawl, Unmanaged silos]
QH6[Integration: Point-to-point spaghetti, Breaking changes]
QH7[Observability: Infra-only metrics, Unstructured logs]
end

classDef adopt fill=#b7f5c7,stroke=#2f7,stroke-width=1px,color=#000;
classDef trial fill=#cbe8ff,stroke=#39f,stroke-width=1px,color=#000;
classDef assess fill=#fff1a8,stroke=#fc3,stroke-width=1px,color=#000;
classDef hold fill=#ffc2c2,stroke=#f55,stroke-width=1px,color=#000;

class Q1 adopt;
class Q2 trial;
class Q3 assess;
class Q4 hold;
```

---

## Related Governance Docs

- [Branching Strategy Playbook](branching-strategy.md)
- [Quarterly Radar Review Checklist](quarterly-radar-review.md)
- [ADR Index](../architecture-decision-records/index.md)

## Capsules

Each specialty has a dedicated capsule with detailed best practices:

- [Software Architecture](./software-architecture/README.md)
- [Security](./security/README.md)
- [Cloud Architecture](./cloud-architecture/README.md)
- [DevOps & Platform Engineering](./devops/README.md)
- [Data & Analytics](./data-analytics/README.md)
- [Integration & APIs](./integration/README.md)
- [Observability](./observability/README.md)
Loading
Loading