Standards Quick Reference Index¶

Auto-generated from actual standards files for instant LLM access

Last Updated: January 2025

This index provides quick summaries of all standards sections. Use the codes below with @load syntax for efficient access.

🎯 Core Standards (CS)¶

| Code | Section | Summary |

|------|---------|---------| | CS:overview | Comprehensive Coding Standards for LLM Projects | > 📚 See also: Unified Software Development Standards | | CS:1-code-style-and-for | 1. Code Style and Formatting | Implement consistent code style and formatting: 1. Follow established style guides for your language | | CS:2-documentation-stan | 2. Documentation Standards | Implement comprehensive documentation standards: 1. Include documentation for all public interfaces: | | CS:3-architecture-and-d | 3. Architecture and Design Patterns | Implement architectural standards and design patterns: 1. Establish clear architectural boundaries: | | CS:4-security-best-prac | 4. Security Best Practices | Implement security best practices in all code: 1. Apply input validation: Validate all user input at | | CS:5-performance-optimi | 5. Performance Optimization | Implement performance standards: 1. Establish performance targets: Define response time goals | | CS:6-error-handling | 6. Error Handling | Implement robust error handling standards: 1. Define error handling strategy: Distinguish between re | | CS:7-resource-managemen | 7. Resource Management | Implement effective resource management: 1. Apply proper resource lifecycle management: Acquire reso | | CS:8-dependency-managem | 8. Dependency Management | Implement dependency management standards: 1. Define dependency selection criteria: Evaluate license |

🔒 Security Standards (SEC)¶

| Code | Section | Summary |

|------|---------|---------| | SEC:overview | Modern Security Standards | > 📚 See also: Unified Software Development Standards | | SEC:tldr | TL;DR | Zero Trust Architecture implementing "never trust, always verify" with continuous authentication and | | SEC:nist-compliance-inte | NIST Compliance Integration | This standard is fully mapped to NIST 800-53r5 controls. Look for @nist tags throughout. For imple | | SEC:1-zero-trust-archite | 1. Zero Trust Architecture | graph TB subgraph "External Enti | | SEC:2-supply-chain-secur | 2. Supply Chain Security | name: Generate SBOM on: push: | | SEC:3-container-and-kube | 3. Container and Kubernetes Security | rule: Unexpected Network Traffic desc: Detect unexpected network connections from containers conditi | | SEC:4-api-security | 4. API Security | apiVersion: configuratio | | SEC:5-devsecops-integrat | 5. DevSecOps Integration | graph TD subgraph "Developer Workflow" DEV[Developer] → CODE[Write Code] | | SEC:implementation-check | Implementation Checklist | [ ] Identity verification policies implemented [ ] Network micro-segmentation configured [ ] Risk-ba |

🧪 Testing Standards (TS)¶

| Code | Section | Summary |

|------|---------|---------| | TS:overview | Comprehensive Testing Manifesto for LLM Coding Projects | > 📚 See also: Unified Software Development Standards | | TS:core-testing-princip | Core Testing Principles | graph TD subgraph "Testing Pyramid" | | TS:quality-assurance-st | Quality Assurance Standards | Implement comprehensive code coverage standards in your testing: 1. Establish minimum code coverage | | TS:security-and-resilie | Security and Resilience | Implement comprehensive | | TS:documentation-and-in | Documentation and Integration | Implement documentation testing to ensure accuracy and reliability: 1. Test all code examples in doc | | TS:master-prompt-for-te | Master Prompt for Test Suite Generation | Generate a comprehensive test suite for this code that follows the Complete Testing Manifesto: 1. Co | | TS:implementation | Implementation | 1. Review the relevant sections of this standard for your use case 2. Identify which guidelines appl | | TS:related-standards | Related Standards | Knowledge Management Standards - Documentation practices CREATING_STANDARDS_GUIDE.md - Standards cre |

💻 Frontend Standards (FE)¶

| Code | Section | Summary |

|------|---------|---------| | FE:overview | Frontend and Mobile Development Standards | > 📚 See also: Unified Software Development Standards | | FE:tldr | TL;DR | Modern frontend architecture with component-based design, state management patterns, and performance | | FE:1-frontend-architect | 1. Frontend Architecture Standards | frontend-app/ ├── public/ # Static assets │ ├── index.html | | FE:2-reactvueangular-st | 2. React/Vue/Angular Standards | // Custom Hooks Pattern import { useState, useEffect, useCallback } from 'react'; import { apiServic | | FE:3-state-management | 3. State Management | // store/index.ts import { configureStore } from 'reduxjs/toolkit'; import { persistStore, persistR | | FE:4-performance-and-op | 4. Performance and Optimization | // utils/performance.ts interface PerformanceMetrics { fcp: number; // First Contentful Paint | | FE:5-progressive-web-ap | 5. Progressive Web Apps (PWA) | // service-worker.ts const CACHE_NAME = 'app-v1.0.0'; const STATIC_CACHE = 'static-v1.0.0'; | | FE:6-mobile-development | 6. Mobile Development Standards | mobile-app/ ├── src/ │ ├── components/ # Reusable components | | FE:implementation-check | Implementation Checklist | [ ] Project structure follows standards [ ] TypeScript configured with strict settings [ ] Build sys |

☁️ Cloud Native Standards (CN)¶

| Code | Section | Summary |

|------|---------|---------| | CN:overview | Cloud-Native and Container Standards | > 📚 See also: Unified Software Development Standards | | CN:1-container-standard | 1. Container Standards | FROM node:18-alpine AS builder WORKDIR /app COPY package*.json ./ | | CN:2-kubernetes-standar | 2. Kubernetes Standards | apiVersion: v1 kind: Namespace metadata: | | CN:3-infrastructure-as- | 3. Infrastructure as Code | terraform/ ├── environments/ │ ├── dev/ | | CN:4-serverless-archite | 4. Serverless Architecture | // AWS Lambda example exports.handler = async (event, context) => { // Initialize outside handler fo | | CN:5-service-mesh | 5. Service Mesh | apiVersion: networking.istio.io/v1beta1 kind: VirtualService metadata: | | CN:6-cloud-provider-sta | 6. Cloud Provider Standards | { "Tags": [ {"Key": "Environment", "Value": "production"}, | | CN:7-cloud-native-secur | 7. Cloud-Native Security | name: Run Trivy vulnerability scanner uses: aquasecurity/trivy-action@master with: | | CN:8-monitoring-and-obs | 8. Monitoring and Observability | apiVersion: monitoring.coreos.com/v1 kind: ServiceMonitor metadata: |

📊 Data Engineering (DE)¶

| Code | Section | Summary |

|------|---------|---------| | DE:overview | Data Engineering Standards | > 📚 See also: Unified Software Development Standards | | DE:tldr | TL;DR | Modern data pipeline architecture with ETL/ELT patterns, orchestration frameworks, and automated dat | | DE:1-data-pipeline-stan | 1. Data Pipeline Standards | class DataPipeline: """Base class for all data pipelines.""" def init(self, config: PipelineConf | | DE:2-data-quality-and-g | 2. Data Quality and Governance | from abc import ABC, abstractmethod from dataclasses import dataclass from typing import List, Dict, | | DE:3-data-storage-and-m | 3. Data Storage and Modeling | Dimension table example CREATE TABLE dim_customers ( customer_key BIGINT IDENTITY(1,1) PRIMARY KEY, | | DE:4-streaming-data-pro | 4. Streaming Data Processing | topics: name: "customer.events.v1" partitions: 12 | | DE:5-analytics-engineer | 5. Analytics Engineering | analytics/ ├── dbt_project.yml ├── packages.yml | | DE:implementation-check | Implementation Checklist | [ ] ETL/ELT pipelines follow standard structure [ ] Error handling and retry logic implemented [ ] D |

🔧 DevOps Standards (DOP)¶

| Code | Section | Summary |

|------|---------|---------| | DOP:overview | DevOps and Platform Engineering Standards | > 📚 See also: Unified Software Development Standards | | DOP:tldr | TL;DR | Infrastructure as Code with Terraform/Pulumi for reproducible, version-controlled infrastructure man | | DOP:1-infrastructure-as- | 1. Infrastructure as Code (IaC) | terraform { required_version = ">= 1.5.0" required_providers { | | DOP:2-cicd-pipeline-stan | 2. CI/CD Pipeline Standards | name: CI/CD Pipeline on: push: | | DOP:3-container-orchestr | 3. Container Orchestration | apiVersion: apps/v1 kind: Deployment metadata: | | DOP:4-platform-engineeri | 4. Platform Engineering | platform: name: "Internal Developer Platform" version: "2.0" | | DOP:5-site-reliability-e | 5. Site Reliability Engineering | apiVersion: sloth.slok.dev/v1 kind: PrometheusServiceLevel metadata: | | DOP:6-gitops-and-deploym | 6. GitOps and Deployment | apiVersion: argoproj.io/v1alpha1 kind: Application metadata: | | DOP:7-configuration-mana | 7. Configuration Management | apiVersion: v1 kind: ConfigMap metadata: |

📈 Observability (OBS)¶

| Code | Section | Summary |

|------|---------|---------| | OBS:overview | Observability and Monitoring Standards | > 📚 See also: Unified Software Development Standards | | OBS:tldr | TL;DR | Three pillars approach combining metrics, logs, and distributed traces for complete system observabi | | OBS:1-observability-prin | 1. Observability Principles | observability: strategy: "three_ | | OBS:2-metrics-and-monito | 2. Metrics and Monitoring | global: scrape_interval: 15s evaluation_interval: 15s | | OBS:3-distributed-tracin | 3. Distributed Tracing | apiVersion: v1 kind: ConfigMap metadata: | | OBS:4-logging-standards | 4. Logging Standards | import json import logging | | OBS:5-service-level-obje | 5. Service Level Objectives (SLOs) | slos: user_service: availability: | | OBS:6-alerting-and-incid | 6. Alerting and Incident Response | groups: name: SLO_Alerts rules: | | OBS:implementation-check | Implementation Checklist | [ ] OpenTelemetry instrumentation implemented [ ] Three pillars (metrics, logs, traces) configured [ |

💰 Cost Optimization (COST)¶

| Code | Section | Summary |

|------|---------|---------| | COST:overview | Cost Optimization and FinOps Standards | > 📚 See also: Unified Software Development Standards | | COST:tldr | TL;DR | FinOps framework for cloud cost management through collaboration, accountability, and continuous opt | | COST:1-finops-principles- | 1. FinOps Principles and Framework | finops_principles: collaboration: description: "Teams work together to optimize cloud costs" | | COST:2-cloud-cost-managem | 2. Cloud Cost Management | import boto3 import pandas as pd from datetime import datetime, timedelta | | COST:3-resource-optimizat | 3. Resource Optimization | import boto3 import pandas as pd from datetime import datetime, timedelta | | COST:4-cost-monitoring-an | 4. Cost Monitoring and Alerting | import numpy as np import pandas as pd from sklearn.ensemble import IsolationForest | | COST:implementation-check | Implementation Checklist | [ ] FinOps principles documented and communicated [ ] Cross-functional team established [ ] Roles an |

📚 Knowledge Management (KM)¶

| Code | Section | Summary |

|------|---------|---------| | KM:overview | Knowledge Management Standards | > 📚 See also: Unified Software Development Standards | | KM:-table-of-contents | 📋 Table of Contents | 1. Overview 2. Core Principles 3. Knowledge Architecture | | KM:core-principles | Core Principles | Knowledge should be accessible at multiple levels of detail, allowing users to start simple and dive | | KM:section-name | Section Name | Summary: One-line description for quick reference Tokens: ~500 (helps AI plan context usage) Priorit | | KM:knowledge-architectu | Knowledge Architecture | project-root/ ├── README.md # Entry point with quick start ├── CLAUDE.md # AI interface and routing | | KM:documentation-standa | Documentation Standards | Every knowledge document must follow this structure: Version: X.Y.Z Last Updated: YYYY-MM-DD | | KM:core-content | Core Content | [Main knowledge sections] | | KM:implementation | Implementation | [Practical examples and patterns] | | KM:references | References | [Related documents and resources] Use explicit tags to indicate requirement levels: Must be implemen |

🤖 Model Context Protocol (MCP)¶

| Code | Section | Summary |

|------|---------|---------| | MCP:overview | Model Context Protocol Standards | > 📚 See also: Unified Software Development Standards | | MCP:-micro-summary-100-t | 🎯 Micro Summary (100 tokens) | MCP enables AI assistants to interact with external services through: Servers: Expose tools/resource | | MCP:core-principles | Core Principles | Summary: Minimize token usage while preserving essential context Priority: Critical Token Estimate: | | MCP:mcp-architecture-sta | MCP Architecture Standards | Section Summary: Define modular server structure, manifest requirements, and transport options Token | | MCP:server-implementatio | Server Implementation Standards | Section Summary: Base server class, error handling patterns, and implementation examples Tokens: ~25 | | MCP:client-integration-s | Client Integration Standards | Section Summary: Client interface, connection management, and intelligent caching Tokens: ~2000 | Pr | | MCP:tool-development-sta | Tool Development Standards | Section Summary: Tool structure, parameter validation, and concrete examples Tokens: ~2200 | Priorit | | MCP:resource-management- | Resource Management Standards | Section Summary: Resource contracts, caching strategies, and common resource types Tokens: ~1800 | P | | MCP:security-and-privacy | Security and Privacy Standards | Section Summary: Authentication, input validation, and privacy controls Tokens: ~2500 | Priority: Cr |

🗄️ Database Standards (DBS)¶

| Code | Section | Summary |

|------|---------|---------| | DBS:overview | Database Standards | > 📚 See also: Unified Software Development Standards | | DBS:sql-design-patterns | SQL Design Patterns | Primary key convention CREATE TABLE users ( id BIGSERIAL PRIMARY KEY, | | DBS:nosql-patterns | NoSQL Patterns | // User document with embedded data { "_id": ObjectId("..."), | | DBS:data-modeling | Data Modeling | 3NF: Eliminate transitive dependencies CREATE TABLE products ( id BIGSERIAL PRIMARY KEY, | | DBS:query-optimization | Query Optimization | Explain analyze for performance EXPLAIN (ANALYZE, BUFFERS) SELECT u.*, COUNT(o.id) as order_count | | DBS:migration-strategies | Migration Strategies | graph TD START[Start Migration] → BACKUP[Create Backup] BACKUP → VALIDATE[Validate Migration Scr | | DBS:security-standards | Security Standards | Role-based access CREATE ROLE app_read; GRANT SELECT ON ALL TABLES IN SCHEMA public TO app_read; | | DBS:backup-and-recovery | Backup and Recovery | archive_mode = on archive_command = 'cp %p /backup/archive/%f' pg_basebackup -D /backup/base -Ft -z | | DBS:monitoring-and-perfo | Monitoring and Performance | Connection monitoring SELECT datname, |

🏗️ Microservices Architecture (MSA)¶

| Code | Section | Summary |

|------|---------|---------| | MSA:overview | Microservices Architecture Standards | > 📚 See also: Unified Software Development Standards | | MSA:tldr | TL;DR | Domain-driven design for service boundaries based on business capabilities with autonomous team owne | | MSA:1-service-design-and | 1. Service Design and Boundaries | graph TB subgraph "Frontend Layer" WEB[Web App] | | MSA:2-communication-patt | 2. Communication Patterns | graph TD subgraph "Synchronous Communication" CLIENT[Client Application] | | MSA:3-service-discovery- | 3. Service Discovery and Registration | from typing import Dict, List, Optional import consul import etcd3 | | MSA:4-resilience-and-cir | 4. Resilience and Circuit Breakers | from enum import Enum from typing import Callable, Any, Optional import time | | MSA:5-data-management-an | 5. Data Management and Consistency | data_management_patterns: database_per_service: principles: | | MSA:6-security-and-authe | 6. Security and Authentication | service_authentication: patterns: mutual_tls: | | MSA:7-testing-microservi | 7. Testing Microservices | testing_pyramid: unit_tests: percentage: 70 |

🤖 ML/AI Standards (ML)¶

| Code | Section | Summary |

|------|---------|---------| | ML:overview | ML/AI Standards | > 📚 See also: Unified Software Development Standards | | ML:1-mlops-principles | 1. MLOps Principles | mlops: principles: reproducibility: "All experiments and models must be reproducible" | | ML:2-model-development- | 2. Model Development Lifecycle | from dataclasses import dataclass from typing import Dict, Any, Optional import mlflow | | ML:3-model-deployment-a | 3. Model Deployment and Serving | from fastapi import FastAPI, HTTPException from pydantic import BaseModel import joblib | | ML:4-model-monitoring-a | 4. Model Monitoring and Maintenance | from prometheus_client import Counter, Histogram, Gauge prediction_counter = Counter('ml_predictions | | ML:5-ai-ethics-and-resp | 5. AI Ethics and Responsible AI | class FairnessAnalyzer: """Analyze model fairness across protected attributes.""" def demographic_pa | | ML:6-data-pipeline-for- | 6. Data Pipeline for ML | from great_expectations import DataContext class MLDataValidator: """Validate data for ML pipelines. | | ML:7-experimentation-an | 7. Experimentation and Tracking | import wandb from typing import Dict, Any class ExperimentTracker: | | ML:8-implementation-che | 8. Implementation Checklist | [ ] Data Pipeline [ ] Data validation implemented [ ] Feature engineering pipeline defined |

🌐 Unified Standards (UNIFIED)¶

| Code | Section | Summary |

|------|---------|---------| | UNIFIED:overview | Unified Software Development Standards | Version: 1.0.0 Last Updated: January 2025 Status: Active Standard Code: UNIFIED | | UNIFIED:1-introduction | 1. Introduction | This document establishes comprehensive software development standards to ensure consistent, high-qu | | UNIFIED:2-quick-reference | 2. Quick Reference | [ ] Code follows language-specific style guide [REQUIRED] [ ] All public interfaces have documentati | | UNIFIED:3-development-standa | 3. Development Standards | 1. Consistency over personal preference 2. Readability over cleverness 3. Maintainability over optim | | UNIFIED:4-testing-standards | 4. Testing Standards | Test individual components in isolation Fast execution (< 100ms per test) No external dependencies | | UNIFIED:5-operational-standa | 5. Operational Standards | 1. Trunk-Based Development (Recommended) Short-lived feature branches Frequent integration | | UNIFIED:6-specialized-standa | 6. Specialized Standards | 1. Resource-Oriented Nouns, not verbs Hierarchical structure | | UNIFIED:7-implementation-gui | 7. Implementation Guide | 1. Week 1-2: Establish tooling and automation 2. Week 3-4: Implement core standards 3. Month 2: Add | | UNIFIED:8-templates-and-chec | 8. Templates and Checklists | [ ] Code does what it's supposed to do [ ] Edge cases handled [ ] Error handling appropriate |

🔐 Compliance Standards (COMPLIANCE)¶

| Code | Section | Summary |

|------|---------|---------| | COMPLIANCE:overview | Compliance Standards | Version: 1.0.0 Last Updated: 2025-01-18 Status: Active Standard Code: COMPLIANCE | | COMPLIANCE:purpose | Purpose | This document establishes standards for integrating NIST 800-53r5 security controls into our develop | | COMPLIANCE:nist-control-tagging | NIST Control Tagging | Tag code, configuration, and documentation when implementing: 1. Security Functions Authentication m | | COMPLIANCE:annotation-formats | Annotation Formats | / @nist ac-2 Account Management @nist ac-2.1 Automated System Account Management | | COMPLIANCE:access-control-polic | Access Control Policy | This section defines... | | COMPLIANCE:authentication-desig | Authentication Design | The system implements multi-factor authentication using: 1. Something you know | | COMPLIANCE:evidence-collection | Evidence Collection | 1. Code Evidence Function/class with @nist tags Implementation patterns | | COMPLIANCE:compliance-workflow | Compliance Workflow | graph LR A[Write Code] → B{Security Feature?} B →|Yes| C[Add NIST Tags] | | COMPLIANCE:llm-integration | LLM Integration | When working with code that needs NIST tags, provide this context: You are helping tag code with NIS |

📋 Additional Standards¶

| Code | Section | Summary |

|------|---------|---------| | PM:overview | Project Management Standards | > 📚 See also: Unified Software Development Standards | | PM:1-core-principles | 1. Core Principles | core_principles: customer_focus: Deliver value early and continuously | | PM:2-methodology-framew | 2. Methodology Framework | methodology_guide: agile_scrum: use_when: | | PM:3-project-lifecycle | 3. Project Lifecycle | lifecycle_phases: initiation: activities: | | PM:4-agile-implementati | 4. Agile Implementation | sprint_standards: planning: duration: "4 hours for 2-week sprint" | | PM:5-planning-and-execu | 5. Planning and Execution | project_charter: components: vision: "Why this project exists" | | PM:6-risk-and-issue-man | 6. Risk and Issue Management | risk_management: identification: techniques: | | PM:7-stakeholder-engage | 7. Stakeholder Engagement | stakeholder_analysis: mapping: dimensions: | | PM:8-team-excellence | 8. Team Excellence | team_development: stages: forming: | | LEG:overview | Legal Compliance Standards | > 📚 See also: Unified Software Development Standards | | LEG:-important-legal-dis | ⚠️ IMPORTANT LEGAL DISCLAIMER ⚠️ | THIS DOCUMENT DOES NOT CONSTITUTE LEGAL ADVICE This document provides technical implementation guide | | LEG:1-core-compliance-pr | 1. Core Compliance Principles | compliance_principles: privacy_by_design: Build privacy into system architecture | | LEG:2-privacy-and-data-p | 2. Privacy and Data Protection | privacy_implementation: consent_management: requirements: | | LEG:3-software-licensing | 3. Software Licensing | license_management: dependency_scanning: tools: | | LEG:4-accessibility-stan | 4. Accessibility Standards | accessibility_standards: wcag_2_1_level_aa: perceivable: | | LEG:5-security-complianc | 5. Security Compliance | security_compliance: frameworks: soc2: | | LEG:6-intellectual-prope | 6. Intellectual Property | ip_protection: code_ownership: documentation: | | LEG:7-audit-and-document | 7. Audit and Documentation | documentation_standards: required_documents: policies: | | WD:overview | Web Design and UX Standards | > 📚 See also: Unified Software Development Standards | | WD:tldr | TL;DR | User-centered design principles focusing on clarity, consistency, and accessibility across all inter | | WD:1-design-principles- | 1. Design Principles and Philosophy | user_centered_design: principles: clarity: | | WD:2-visual-design-stan | 2. Visual Design Standards | // styles/grid.scss // 12-column grid system with responsive breakpoints $grid-columns: 12; | | WD:3-typography-and-con | 3. Typography and Content Layout | // styles/typography.scss // Modular type scale (1.250 - Major Third) \(type-scale-ratio: 1.250; | | WD:4-color-systems-and- | 4. Color Systems and Theming | // styles/colors.scss // Semantic color system with light/dark theme support // Brand colors | | WD:5-component-design-s | 5. Component Design Systems | // components/Button/Button.tsx import React, { forwardRef } from 'react'; import { clsx } from 'cls | | WD:when-to-use | When to use | Primary actions: Use primary buttons for the main action on a page Secondary actions: Use secondary | | WD:accessibility | Accessibility | All buttons must have accessible labels Use aria-label for icon-only buttons Ensure sufficient color | | SEO:overview | SEO & Web Marketing Standards | > 📚 See also: Unified Software Development Standards | | SEO:1-technical-seo-foun | 1. Technical SEO Foundations | crawlability_standards: robots_txt: location: "/robots.txt" | | SEO:2-on-page-optimizati | 2. On-Page Optimization | meta_tags: title_tag: requirements: | | SEO:3-site-architecture- | 3. Site Architecture and Navigation | site_architecture: hierarchy: depth: "Maximum 3 clicks from homepage" | | SEO:4-performance-and-co | 4. Performance and Core Web Vitals | core_web_vitals: lcp_optimization: target: "< 2.5 seconds" | | SEO:5-schema-and-structu | 5. Schema and Structured Data | structured_data: formats: json_ld: "Recommended" | | SEO:6-content-marketing- | 6. Content Marketing Technical Standards | content_management: content_types: blog_posts: | | SEO:7-analytics-and-trac | 7. Analytics and Tracking | analytics_setup: google_analytics_4: implementation: | | SEO:8-marketing-automati | 8. Marketing Automation | marketing_automation: lead_capture: forms: | | EVT:overview | Event-Driven Architecture Standards | > 📚 See also: Unified Software Development Standards | | EVT:1-event-driven-desig | 1. Event-Driven Design Principles | event_driven_principles: "Events as first-class citizens" "Loose coupling between services" | | EVT:2-event-schema-and-c | 2. Event Schema and Contracts | { "\)schema": "http://json-schema.org/draft-07/schema#", "title": "CloudEvent Schema", | | EVT:3-message-brokers-an | 3. Message Brokers and Queues | topics: order-events: partitions: 12 | | EVT:4-event-sourcing-pat | 4. Event Sourcing Patterns | // Event store interface interface EventStore { saveEvents(streamId: string, events: DomainEvent[], | | EVT:5-cqrs-implementatio | 5. CQRS Implementation | // Command side interface Command { readonly id: string; | | EVT:6-saga-patterns | 6. Saga Patterns | // Saga orchestrator abstract class Saga { protected state: SagaState = SagaState.NotStarted; | | EVT:7-event-processing-a | 7. Event Processing and Analytics | // Real-time event processing with Kafka Streams import { KafkaStreams } from 'kafka-streams'; class | | EVT:implementation-check | Implementation Checklist | [ ] Event schema standards defined [ ] Message broker configured [ ] Event versioning strategy imple | | GH:overview | GitHub Platform Standards | > 📚 See also: Unified Software Development Standards | | GH:1-repository-standar | 1. Repository Standards | project-name/ ├── .github/ # GitHub-specific files │ ├── workflows/ # GitHub Actions workflows | | GH:-quick-start | 🚀 Quick Start | npm install npm run dev npm test | | GH:-prerequisites | 📋 Prerequisites | Node.js >= 18 npm >= 9 | | GH:-installation | 🛠️ Installation | Detailed installation instructions. | | GH:-documentation | 📖 Documentation | Contributing Guide Code of Conduct | | GH:-testing | 🧪 Testing | npm test npm run test:coverage npm test -- --grep "test name" | | GH:-contributing | 🤝 Contributing | Please read CONTRIBUTING.md for details. | | GH:-license | 📝 License | This project is licensed under the MIT License - see LICENSE. | | CONT:overview | Content Standards | > 📚 See also: Unified Software Development Standards | | CONT:tldr | TL;DR | Content strategy framework aligning business objectives with user needs through clear governance and | | CONT:1-content-strategy-a | 1. Content Strategy and Governance | content_strategy: mission: statement: "Deliver clear, helpful, and accessible content that empowers | | CONT:2-writing-guidelines | 2. Writing Guidelines | grammar_standards: sentence_structure: preferred: | | CONT:title-h1 | Title (H1) | Clear, descriptive, and keyword-rich Maximum 60 characters for SEO Accurately represents content | | CONT:content-patterns | Content Patterns | 1. Problem Statement: What issue does this solve? 2. Prerequisites: What's needed before starting 3. | | CONT:3-tone-and-voice | 3. Tone and Voice | brand_voice: personality_traits: primary: | | CONT:api-reference-templa | API Reference Template | Description: Brief explanation of what this endpoint does Method: GET | POST | PUT | DELETE URL: | |CONT:feature-name| Feature Name | Clear learning objectives Expected outcomes Time to complete | |TOOL:overview| Toolchain Standards | > 📚 See also: Unified Software Development Standards | |TOOL:purpose| Purpose | This document provides centralized, standardized tool recommendations for all development activities | |TOOL:tool-selection-guide| Tool Selection Guidelines | Tools are categorized into five recommendation levels: | Level | Description | Action | |-------|--- | |TOOL:language-specific-to| Language-Specific Toolchains | Formatter:black(v23.0+) - The uncompromising code formatter Import Sorter:isort(v5.0+) - Imp | |TOOL:infrastructure-tools| Infrastructure Tools | Container Runtime:docker(v24.0+) orpodman(v4.0+) Orchestration:kubernetes(v1.28+) with | | TOOL:security-scanning | Security Scanning | 1. Dependency Scanning: dependabot (GitHub) or renovate 2. Container Scanning: trivy for all c | | TOOL:observability-stack | Observability Stack | Collection: prometheus (v2.45+) Visualization: grafana (v10.0+) Alerting: Prometheus Alertmanage | | TOOL:tool-configuration | Tool Configuration | All tool configurations should be centralized: project-root/ ├── pyproject.toml # Python tools (blac | | TOOL:migration-paths | Migration Paths | pip install ruff ruff check --fix . [tool.ruff] |

🚀 Quick Loading Examples¶

# Load specific standard section
@load CS:api

# Load multiple related standards
@load [CS:api + SEC:api + TS:integration]

# Load by task context
@load context:[new-python-api]  # Loads: CS:python + CS:api + SEC:api + TS:pytest

# Load by natural language
@ask "How to secure my API?" # Auto-loads: SEC:api + CS:security + TS:security

📊 Statistics¶

Total Standards: 25 documents
Total Sections: 212+ specialized topics
Quick Load Time: <100ms per section
Token Savings: ~95% compared to full document loading

Note: This index is auto-generated from the actual standards files. For detailed implementation, use @load [standard:section] to fetch full content.

Generated by: generate_standards_index.py