# Tech Architecture Doc

> Create comprehensive technical architecture documentation for the saxjaxTunerIntelligent audio processing pipeline. Use this when onboarding developers, documenting system architecture, or explaining the audio data flow and settings integration.

- Skill: `majiayu000/tech-architecture-doc` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add majiayu000/tech-architecture-doc`
- Raw SKILL.md: https://api.skillmd.com/api/skills/majiayu000/tech-architecture-doc/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: DevOps & Infra
- Author: majiayu000 (https://skillmd.com/u/majiayu000)
- Updated: 2026-09-09
- Page: https://skillmd.com/skills/majiayu000/tech-architecture-doc

---


# Technical Architecture Documentation Generator

Write comprehensive technical architecture documents for the saxjaxTunerIntelligent project, focusing on audio processing pipeline and settings integration.

## Document Structure

### Part 1: Core Audio Architecture & Data Flow

1. **Technology Stack & High-Level Design**
   - Core technologies: Swift, SwiftUI, AudioKit
   - High-level audio flow: Microphone → AudioKit Engine → Pitch Tap → Detection → ViewModel → View
   - **Include Mermaid.js flow diagram**

2. **TunerEngine.swift Deep Dive**
   - **Role & Responsibility**: Central audio operations manager
   - **AudioKit Integration**: How it uses AudioEngine, InputDevice, Mixer nodes
   - **Input and Pitch Tap**: 
     - How audio is captured from microphone
     - Explain tap concept (`installTap`) for real-time, non-destructive analysis
   - **Pitch Detection Algorithm**:
     - Which algorithm is used (YIN, DYWA, HPS, etc.)
     - Reference `PitchDetectorType.swift` for abstraction
   - **Output Data Flow**:
     - Data structure (PitchResult, DetectedNote)
     - How results pass to TunerViewModel (delegate, Combine, callback)

### Part 2: Settings Integration & Functional Impact

**Include high-level Mermaid diagram** showing how settings influence main data flow

For each setting, provide:
1. **Setting Name**
2. **User Interface (UI)**: Where configured (SettingsView, QuickAccessBar)
3. **Data Model & State**: Where stored (TuningProfile, TunerViewModel)
4. **Core Logic Integration**: How TunerEngine uses this value
5. **Functional Impact & Purpose**: Effect on algorithm/UI, why musicians use it, practical example

### Settings to Analyze
- Transposition
- A4 Frequency / Kammertone
- Tuning Tolerance
- Sound Playback (reference tone)

## Mermaid Diagram Examples

### Audio Flow
```mermaid
graph LR
    A[Microphone] --> B[AudioKit Engine]
    B --> C[Pitch Tap]
    C --> D[Pitch Detection Algorithm]
    D --> E[TunerViewModel]
    E --> F[SwiftUI View]
```

### Settings Integration
```mermaid
graph TB
    A[Audio Input] --> B[TunerEngine]
    C[TuningProfile Settings] -.influences.-> B
    B --> D[Pitch Detection]
    C -.influences.-> D
    D --> E[Display Calculation]
    C -.influences.-> E
```

## Writing Guidelines
- Be exceptionally specific and clear
- Reference actual file names and component names
- Include code locations where relevant
- Explain data flow with precision
- Use visual diagrams to clarify complex flows
- Target audience: Senior engineer new to the project