@ngocsangairvds/vsaf 3.2.14 → 3.2.15

package/tools/vds-scripts/audit_orchestrator/docs/API.md

@@ -1,804 +0,0 @@
-# Audit Orchestrator - API Documentation
-
-Developer API reference for the VDS Audit Orchestrator.
-
-## Table of Contents
-
-- [Core Models](#core-models)
-  - [AuditTemplate](#audittemplate)
-  - [AuditSection](#auditsection)
-  - [AuditCheck](#auditcheck)
-- [Result Models](#result-models)
-  - [RepositoryAuditResult](#repositoryauditresult)
-  - [SectionResult](#sectionresult)
-  - [CheckFinding](#checkfinding)
-- [Plugin Development](#plugin-development)
-  - [BaseCheck](#basecheck)
-  - [CheckContext](#checkcontext)
-  - [CheckResult](#checkresult)
-  - [CheckRegistry](#checkregistry)
-- [Engine API](#engine-api)
-- [Enums](#enums)
-
----
-
-## Core Models
-
-### AuditTemplate
-
-Main audit template containing sections and validation logic.
-
-```python
-from vds_audit_orchestrator.models.template import AuditTemplate
-
-template = AuditTemplate(
-    name="VDS Base Audit",
-    version="1.0.0",
-    sections=[...]
-)
-```
-
-**Attributes:**
-
-| Name | Type | Description |
-|------|------|-------------|
-| `name` | `str` | Template name/identifier |
-| `version` | `str` | Template version (semver recommended) |
-| `sections` | `list[AuditSection]` | Audit sections defining the template |
-
-**Properties:**
-
-| Name | Type | Description |
-|------|------|-------------|
-| `total_checks` | `int` | Total number of checks across all sections |
-| `required_checks` | `list[AuditCheck]` | All required checks across all sections |
-
-**Methods:**
-
-```python
-# Get section by ID
-section = template.get_section_by_id("security")
-
-# Get check by ID
-check = template.get_check_by_id("SEC-001")
-
-# Get checks by tag
-security_checks = template.get_checks_by_tag("security")
-
-# Get sections by tag
-security_sections = template.get_sections_by_tag("security")
-```
-
-**Validation:**
-
-The template automatically validates on initialization:
-- Section weights must sum to 100.0
-- Check weights within each section are normalized
-
----
-
-### AuditSection
-
-Represents a category/group of related audit checks.
-
-```python
-from vds_audit_orchestrator.models.template import AuditSection
-
-section = AuditSection(
-    id="security",
-    name="Security Controls",
-    description="Security and compliance checks",
-    weight=30.0,
-    scoring_policy="weighted_mean",
-    target_score=None,
-    score_cap=None,
-    confidence_mode="coverage",
-    tags=["security"],
-    checks=[...]
-)
-```
-
-**Attributes:**
-
-| Name | Type | Default | Description |
-|------|------|---------|-------------|
-| `id` | `str` | required | Unique section identifier |
-| `name` | `str` | required | Human-readable name |
-| `description` | `str` | `""` | Section description |
-| `weight` | `float` | required | Relative weight (0-100, sum of all = 100) |
-| `scoring_policy` | `str` | `"weighted_mean"` | Aggregation policy |
-| `target_score` | `float | None` | `None` | Maturity target (0-100) |
-| `score_cap` | `float | None` | `None` | Max score when critical checks fail |
-| `confidence_mode` | `str` | `"coverage"` | Confidence calculation mode |
-| `tags` | `list[str]` | `[]` | Section tags |
-| `checks` | `list[AuditCheck]` | `[]` | Audit checks in this section |
-
-**Scoring Policies:**
-
-| Policy | Description |
-|--------|-------------|
-| `weighted_mean` | Default - weighted average of check scores |
-| `maturity` | Maturity model aggregation by practice_id |
-| `compliance_gate` | All required checks must pass or cap applied |
-
-**Confidence Modes:**
-
-| Mode | Description |
-|------|-------------|
-| `coverage` | Based on ERROR check ratio |
-| `confidence` | Average of check.confidence values |
-| `both` | Multiply coverage and confidence factors |
-
-**Properties:**
-
-```python
-# Default score cap based on tags
-cap = section.default_score_cap  # 60.0 for 'security', 0.0 for 'compliance'
-
-# Effective score cap (explicit or default)
-effective_cap = section.effective_score_cap
-```
-
----
-
-### AuditCheck
-
-Represents an individual audit check within a section.
-
-```python
-from vds_audit_orchestrator.models.template import AuditCheck
-from vds_audit_orchestrator.models.enums import Severity, Priority, MigrationEffort
-
-check = AuditCheck(
-    id="SEC-001",
-    name="Branch Protection",
-    description="Validates branch protection settings",
-    max_points=100,
-    weight=20.0,
-    check_type="bitbucket_branch_permission",
-    section_id="security",
-    check_config={"branch": "main"},
-    score_mode="binary",
-    score_config={},
-    required=False,
-    tags=["security", "governance"],
-    severity=Severity.HIGH,
-    priority=Priority.P2,
-    migration_effort=MigrationEffort.MEDIUM
-)
-```
-
-**Attributes:**
-
-| Name | Type | Default | Description |
-|------|------|---------|-------------|
-| `id` | `str` | required | Unique check identifier |
-| `name` | `str | None` | `None` | Human-readable name |
-| `description` | `str` | required | What the check validates |
-| `max_points` | `int` | `100` | Maximum points achievable |
-| `weight` | `float | None` | `None` | Relative weight within section |
-| `check_type` | `str | None` | `None` | Check plugin name |
-| `section_id` | `str | None` | `None` | Parent section ID |
-| `check_config` | `dict` | `{}` | Configuration parameters |
-| `score_mode` | `str | None` | `None` | binary, threshold, ratio, range, maturity |
-| `score_config` | `dict` | `{}` | Mode-specific configuration |
-| `required` | `bool` | `False` | Required check flag |
-| `enabled` | `bool` | `True` | Whether check is enabled |
-| `tags` | `list[str]` | `[]` | Framework tags |
-| `severity` | `Severity` | `MEDIUM` | Severity level |
-| `priority` | `Priority` | `P3` | Remediation priority |
-| `migration_effort` | `MigrationEffort` | `MEDIUM` | Estimated effort to fix |
-| `remediation_steps` | `str | None` | `None` | Remediation guidance |
-| `doc_link` | `str | None` | `None` | Documentation link |
-
-**Score Modes:**
-
-| Mode | Description |
-|------|-------------|
-| `binary` | Pass/fail (0 or max_points) |
-| `threshold` | Score based on meeting threshold |
-| `ratio` | Partial scoring based on ratio |
-| `range` | Gradient scoring within ranges |
-| `maturity` | Maturity level (0-3) mapped to score |
-
-**Properties:**
-
-```python
-# Effective weight using severity fallback
-# Critical: 10.0, High: 7.5, Medium: 5.0, Low: 2.5
-effective_weight = check.effective_weight
-
-# Aliases for check_type
-check.check_type == check.plugin_name  # True
-check.check_config == check.plugin_config  # True
-```
-
----
-
-## Result Models
-
-### RepositoryAuditResult
-
-Complete audit result for a single repository.
-
-```python
-from vds_audit_orchestrator.models.findings import RepositoryAuditResult
-
-result = RepositoryAuditResult(
-    repo_name="my-service",
-    project_key="PROJ",
-    total_score=85.5,
-    grade="B",
-    sections=[...],
-    critical_issues=1,
-    high_issues=3,
-    medium_issues=10,
-    low_issues=5
-)
-```
-
-**Attributes:**
-
-| Name | Type | Default | Description |
-|------|------|---------|-------------|
-| `repo_name` | `str` | required | Repository name |
-| `project_key` | `str | None` | `None` | Project key |
-| `total_score` | `float` | required | Overall score (0-100) |
-| `grade` | `str` | `"N/A"` | Letter grade (A-F) |
-| `sections` | `list[SectionResult]` | `[]` | Section results |
-| `total_checks` | `int` | `0` | Total checks executed |
-| `passed_checks` | `int` | `0` | Passed checks count |
-| `failed_checks` | `int` | `0` | Failed checks count |
-| `critical_issues` | `int` | `0` | Critical findings count |
-| `high_issues` | `int` | `0` | High findings count |
-| `medium_issues` | `int` | `0` | Medium findings count |
-| `low_issues` | `int` | `0` | Low findings count |
-| `template_name` | `str | None` | `None` | Template used |
-| `template_version` | `str | None` | `None` | Template version |
-| `audit_metadata` | `dict` | `{}` | Additional metadata |
-| `audit_timestamp` | `datetime` | now | Audit timestamp |
-| `duration_seconds` | `float | None` | `None` | Audit duration |
-| `profile_info` | `dict` | `{}` | Profile information |
-| `adaptive_weights` | `dict` | `{}` | Weight adjustment info |
-
-**Properties:**
-
-```python
-# Aliases
-repository_name = result.repository_name  # Same as repo_name
-overall_score = result.overall_score  # Same as total_score
-
-# Pass rate
-pass_rate = result.pass_rate  # Percentage
-
-# Findings
-critical_findings = result.all_critical_findings
-failed_findings = result.all_failed_findings
-
-# Section rankings
-weakest = result.weakest_sections  # Bottom 3
-strongest = result.strongest_sections  # Top 3
-by_score = result.sections_by_score  # All sorted
-```
-
-**Methods:**
-
-```python
-# Get section result
-section_result = result.get_section_result("security")
-
-# Get findings by severity
-high_findings = result.get_findings_by_severity(Severity.HIGH)
-
-# Get findings by tag
-security_findings = result.get_findings_by_tag("security")
-```
-
----
-
-### SectionResult
-
-Aggregated results for a section of checks.
-
-```python
-from vds_audit_orchestrator.models.findings import SectionResult
-
-section_result = SectionResult(
-    section_id="security",
-    section_name="Security Controls",
-    score_percentage=85.0,
-    weighted_contribution=25.5,
-    status=CheckStatus.PASSED,
-    total_checks=10,
-    passed_checks=8,
-    failed_checks=2,
-    findings=[...],
-    coverage_factor=1.0,
-    confidence_factor=0.9,
-    scoring_policy="weighted_mean"
-)
-```
-
-**Attributes:**
-
-| Name | Type | Default | Description |
-|------|------|---------|-------------|
-| `section_id` | `str` | required | Section identifier |
-| `section_name` | `str | None` | `None` | Section name |
-| `score_percentage` | `float` | `0.0` | Section score (0-100) |
-| `weighted_contribution` | `float` | `0.0` | Weighted contribution to total |
-| `status` | `CheckStatus | None` | `None` | Section status |
-| `total_checks` | `int` | `0` | Total checks in section |
-| `passed_checks` | `int` | `0` | Passed checks count |
-| `failed_checks` | `int` | `0` | Failed checks count |
-| `na_checks` | `int` | `0` | N/A checks count |
-| `skipped_checks` | `int` | `0` | Skipped checks count |
-| `findings` | `list[CheckFinding]` | `[]` | Individual check findings |
-| `coverage_factor` | `float` | `1.0` | Coverage factor (0-1) |
-| `confidence_factor` | `float` | `1.0` | Confidence factor (0-1) |
-| `score_cap_applied` | `float | None` | `None` | Score cap if applied |
-| `scoring_policy` | `str` | `"weighted_mean"` | Aggregation policy used |
-| `target_score` | `float | None` | `None` | Target score |
-| `percent_to_target` | `float | None` | `None` | Percent to target |
-| `required_checks_passed` | `bool` | `True` | Required checks status |
-| `weighting_rationale` | `WeightingRationale | None` | `None` | Weight explanation |
-
-**Properties:**
-
-```python
-# Aliases
-score = section_result.score  # Same as score_percentage
-weighted_score = section_result.weighted_score  # Same as weighted_contribution
-
-# Pass rate
-pass_rate = section_result.pass_rate
-
-# Findings
-critical = section_result.critical_findings
-required_failed = section_result.failed_required_checks
-errors = section_result.error_findings
-
-# Exclusion status
-excluded = section_result.is_excluded_from_scoring  # True if all ERROR
-```
-
----
-
-### CheckFinding
-
-Result of executing a single audit check.
-
-```python
-from vds_audit_orchestrator.models.findings import CheckFinding
-from vds_audit_orchestrator.models.enums import CheckStatus, Severity
-
-finding = CheckFinding(
-    check_id="SEC-001",
-    check_name="Branch Protection",
-    status=CheckStatus.FAILED,
-    score_percentage=0.0,
-    points_awarded=0.0,
-    max_points=100,
-    severity=Severity.HIGH,
-    priority=Priority.P2,
-    migration_effort=MigrationEffort.LOW,
-    message="Branch protection not configured",
-    evidence=["Main branch has no protection rules"],
-    recommendation="Enable branch protection in Bitbucket settings",
-    resource_links=["https://bitbucket.example.com/settings/branches"],
-    confidence=1.0
-)
-```
-
-**Attributes:**
-
-| Name | Type | Default | Description |
-|------|------|---------|-------------|
-| `check_id` | `str` | required | Check identifier |
-| `check_name` | `str | None` | `None` | Check name |
-| `status` | `CheckStatus` | required | PASSED, FAILED, PARTIAL, N/A, ERROR |
-| `score_percentage` | `float` | `0.0` | Score (0-100) |
-| `points_awarded` | `float` | `0.0` | Points earned |
-| `max_points` | `int` | `100` | Maximum points |
-| `severity` | `Severity` | required | Severity level |
-| `priority` | `Priority` | required | Priority level |
-| `migration_effort` | `MigrationEffort` | required | Effort to fix |
-| `message` | `str | None` | `None` | Result message |
-| `details` | `dict | None` | `None` | Additional details |
-| `evidence_data` | `Any | None` | `None` | Raw evidence |
-| `evidence` | `list[str]` | `[]` | Evidence list |
-| `recommendation` | `str | None` | `None` | Remediation guidance |
-| `doc_link` | `str | None` | `None` | Documentation link |
-| `resource_links` | `list[str]` | `[]` | Related resources |
-| `execution_time_ms` | `int` | `0` | Execution time |
-| `confidence` | `float | None` | `None` | Confidence (0-1) |
-| `tags` | `list[str]` | `[]` | Finding tags |
-| `metadata` | `dict` | `{}` | Additional metadata |
-| `error_message` | `str | None` | `None` | Error if applicable |
-
-**Properties:**
-
-```python
-# Aliases
-score = finding.score  # Same as score_percentage
-
-# Status checks
-passed = finding.passed  # True if PASSED
-failed = finding.failed  # True if FAILED or PARTIAL
-applicable = finding.is_applicable  # False if N/A or ERROR
-critical = finding.is_critical  # True if Critical and failed
-needs_action = finding.requires_action  # True if failed
-```
-
----
-
-## Plugin Development
-
-### BaseCheck
-
-Abstract base class for audit check implementations.
-
-```python
-from vds_audit_orchestrator.checks.base import BaseCheck, CheckContext, CheckResult
-from vds_audit_orchestrator.models.enums import CheckStatus
-
-class MyCustomCheck(BaseCheck):
-    """Custom audit check implementation."""
-
-    check_type = "my_custom_check"
-
-    async def execute(self, context: CheckContext) -> CheckResult:
-        """Execute the check logic."""
-        # Implement check logic here
-        try:
-            # Perform validation
-            is_valid = self._validate(context)
-
-            return CheckResult(
-                status=CheckStatus.PASSED if is_valid else CheckStatus.FAILED,
-                score=100.0 if is_valid else 0.0,
-                message="Check completed successfully",
-                evidence={"validated": is_valid},
-                recommendation="Update configuration" if not is_valid else None
-            )
-        except Exception as e:
-            return CheckResult(
-                status=CheckStatus.ERROR,
-                score=0.0,
-                message=f"Check failed: {e}",
-                error_message=str(e)
-            )
-
-    def _validate(self, context: CheckContext) -> bool:
-        """Internal validation logic."""
-        # Implementation
-        return True
-```
-
-**Class Attributes:**
-
-| Name | Type | Description |
-|------|------|-------------|
-| `check_type` | `ClassVar[str]` | Unique check type identifier |
-
-**Required Methods:**
-
-| Method | Signature | Description |
-|--------|-----------|-------------|
-| `execute` | `async (context: CheckContext) -> CheckResult` | Execute the check logic |
-
----
-
-### CheckContext
-
-Context passed to a check during execution.
-
-```python
-@dataclass
-class CheckContext:
-    repo_path: Path
-    config: dict[str, Any] = field(default_factory=dict)
-    repository_name: str = ""
-    project_key: str = ""
-    global_config: dict[str, Any] = field(default_factory=dict)
-    clients: dict[str, Any] = field(default_factory=dict)
-    manifest_data: dict[str, Any] = field(default_factory=dict)
-    metadata: dict[str, Any] = field(default_factory=dict)
-```
-
-**Attributes:**
-
-| Name | Type | Description |
-|------|------|-------------|
-| `repo_path` | `Path` | Path to the repository |
-| `config` | `dict` | Check-specific configuration |
-| `repository_name` | `str` | Repository name |
-| `project_key` | `str` | Project key |
-| `global_config` | `dict` | Global audit configuration |
-| `clients` | `dict` | External service clients |
-| `manifest_data` | `dict` | Repository manifest data |
-| `metadata` | `dict` | Additional metadata |
-
-**Properties:**
-
-```python
-# Alias for config
-check_config = context.check_config  # Same as config
-```
-
----
-
-### CheckResult
-
-Result returned by a check execution.
-
-```python
-@dataclass
-class CheckResult:
-    status: CheckStatus
-    score: float
-    message: str
-    details: str | None = None
-    evidence: dict[str, Any] = field(default_factory=dict)
-    recommendation: str | None = None
-    confidence: float | None = None
-    error_message: str | None = None
-    resource_links: list[str] = field(default_factory=list)
-    tags: list[str] = field(default_factory=list)
-```
-
-**Attributes:**
-
-| Name | Type | Default | Description |
-|------|------|---------|-------------|
-| `status` | `CheckStatus` | required | Check result status |
-| `score` | `float` | required | Score (0-100) |
-| `message` | `str` | required | Result message |
-| `details` | `str | None` | `None` | Additional details |
-| `evidence` | `dict` | `{}` | Evidence data |
-| `recommendation` | `str | None` | `None` | Remediation guidance |
-| `confidence` | `float | None` | `None` | Confidence (0-1) |
-| `error_message` | `str | None` | `None` | Error if applicable |
-| `resource_links` | `list[str]` | `[]` | Related resources |
-| `tags` | `list[str]` | `[]` | Result tags |
-
-**Properties:**
-
-```python
-# Alias
-score_percentage = result.score_percentage  # Same as score
-```
-
----
-
-### CheckRegistry
-
-Registry for check plugins with metadata support.
-
-```python
-from vds_audit_orchestrator.checks.registry import CheckRegistry, CheckMetadata
-from vds_audit_orchestrator.models.enums import Severity
-
-# Register a check with metadata
-@CheckRegistry.register(
-    "my_check",
-    metadata=CheckMetadata(
-        check_type="my_check",
-        name="My Check",
-        description="Validates custom criteria",
-        category="custom",
-        config_schema={
-            "param1": {"type": "string", "required": True}
-        },
-        default_severity=Severity.MEDIUM,
-        tags=["custom", "validation"]
-    )
-)
-class MyCheck(BaseCheck):
-    async def execute(self, context: CheckContext) -> CheckResult:
-        ...
-```
-
-**Class Methods:**
-
-| Method | Signature | Description |
-|--------|-----------|-------------|
-| `register` | `(name: str, metadata: CheckMetadata | None) -> Decorator` | Register a check class |
-| `get_check` | `(name: str) -> type[BaseCheck]` | Get check class by name |
-| `get_metadata` | `(name: str) -> CheckMetadata | None` | Get metadata for check |
-| `list_checks` | `() -> list[str]` | List all registered checks |
-| `list_checks_by_category` | `(category: str) -> list[str]` | List checks by category |
-| `get_all_metadata` | `() -> dict[str, CheckMetadata]` | Get all metadata |
-| `get_categories` | `() -> list[str]` | Get all categories |
-| `get_summary` | `() -> dict[str, Any]` | Get registry summary |
-
-**Usage Examples:**
-
-```python
-# List all checks
-all_checks = CheckRegistry.list_checks()
-
-# List by category
-git_checks = CheckRegistry.list_checks_by_category("git")
-
-# Get check class
-CheckClass = CheckRegistry.get_check("git_file_exists")
-
-# Get metadata
-metadata = CheckRegistry.get_metadata("git_file_exists")
-
-# Get summary
-summary = CheckRegistry.get_summary()
-# {"total_checks": 10, "by_category": {"git": 3, "bitbucket": 2, ...}}
-```
-
----
-
-## Engine API
-
-### AuditEngine
-
-Main audit orchestration engine.
-
-```python
-from vds_audit_orchestrator.engine.auditor import AuditEngine
-
-engine = AuditEngine(concurrency=5)
-
-# Audit a single repository
-result = await engine.audit_repo(repo_path, template)
-
-# The result is a RepositoryAuditResult
-print(f"Score: {result.total_score}")
-```
-
-**Parameters:**
-
-| Name | Type | Default | Description |
-|------|------|---------|-------------|
-| `concurrency` | `int` | `5` | Concurrent checks per repo |
-
-**Methods:**
-
-| Method | Signature | Description |
-|--------|-----------|-------------|
-| `audit_repo` | `async (repo_path: Path, template: AuditTemplate, dry_run: bool) -> RepositoryAuditResult` | Audit a repository |
-
-### TemplateLoader
-
-Load templates from Excel or Google Sheets.
-
-```python
-from vds_audit_orchestrator.engine.loader import ExcelLoader, load_template_from_google_sheet
-
-# Load from Excel
-loader = ExcelLoader()
-template = loader.load(Path("template.xlsx"))
-
-# Load from Google Sheets
-template = load_template_from_google_sheet(
-    spreadsheet_url="https://docs.google.com/spreadsheets/d/...",
-    sheet_name="Checklist",
-    template_map=None
-)
-```
-
-### TemplateValidator
-
-Validate template structure and weights.
-
-```python
-from vds_audit_orchestrator.engine.validator import TemplateValidator
-
-validator = TemplateValidator()
-try:
-    validator.validate(template)
-    print("Template is valid")
-except TemplateValidationError as e:
-    print(f"Validation failed: {e}")
-```
-
----
-
-## Enums
-
-### CheckStatus
-
-```python
-class CheckStatus(str, Enum):
-    PASSED = "PASSED"
-    FAILED = "FAILED"
-    PARTIAL = "PARTIAL"
-    NOT_APPLICABLE = "N/A"
-    ERROR = "ERROR"
-```
-
-### Severity
-
-```python
-class Severity(str, Enum):
-    CRITICAL = "Critical"
-    HIGH = "High"
-    MEDIUM = "Medium"
-    LOW = "Low"
-```
-
-### Priority
-
-```python
-class Priority(str, Enum):
-    P1 = "P1"  # Immediate action required
-    P2 = "P2"
-    P3 = "P3"
-    P4 = "P4"  # Low priority
-```
-
-### MigrationEffort
-
-```python
-class MigrationEffort(str, Enum):
-    LOW = "Low"         # < 1 day
-    MEDIUM = "Medium"   # 1-3 days
-    HIGH = "High"       # 3-5 days
-    VERY_HIGH = "Very High"  # > 5 days
-```
-
----
-
-## Complete Example
-
-```python
-"""Complete example of creating a custom check."""
-from pathlib import Path
-from vds_audit_orchestrator.checks.base import BaseCheck, CheckContext, CheckResult
-from vds_audit_orchestrator.checks.registry import CheckRegistry, CheckMetadata
-from vds_audit_orchestrator.models.enums import CheckStatus, Severity
-
-@CheckRegistry.register(
-    "readme_exists",
-    metadata=CheckMetadata(
-        check_type="readme_exists",
-        name="README Exists",
-        description="Verifies that a README file exists in the repository",
-        category="git",
-        default_severity=Severity.MEDIUM,
-        tags=["documentation", "governance"]
-    )
-)
-class ReadmeExistsCheck(BaseCheck):
-    """Check for README file existence."""
-
-    check_type = "readme_exists"
-
-    async def execute(self, context: CheckContext) -> CheckResult:
-        """Check if README.md exists in the repository."""
-        readme_path = context.repo_path / "README.md"
-        exists = readme_path.exists()
-
-        if exists:
-            return CheckResult(
-                status=CheckStatus.PASSED,
-                score=100.0,
-                message=f"README found at {readme_path}",
-                evidence={"path": str(readme_path), "exists": True},
-                confidence=1.0
-            )
-        else:
-            return CheckResult(
-                status=CheckStatus.FAILED,
-                score=0.0,
-                message="README not found",
-                evidence={"path": str(readme_path), "exists": False},
-                recommendation="Create a README.md file in the repository root",
-                confidence=1.0
-            )
-```
-
----
-
-## Additional Resources
-
-- [DEPLOYMENT.md](DEPLOYMENT.md) - Installation and deployment guide
-- [README.md](../README.md) - Project overview
-- [Requirements](../../../.kiro/specs/audit-orchestrator/requirements.md) - Functional requirements
-- [Design](../../../.kiro/specs/audit-orchestrator/design.md) - Architecture and design