Cleanroom Labs home Cleanroom Labs
About Blog Docs
Development documentation — may change at any time
Cleanroom Whisper

Documentation

  • Overview
    • Features
    • How It Works
    • Quick Start
      • Prerequisites
      • Installation
      • First Run
    • Usage
      • Recording
      • Quick Copy
      • Viewing History
    • Default Hotkeys
    • Building
    • Air-Gapped Deployment
    • Privacy
    • Why Cleanroom Whisper?
    • Platform Support
    • License
    • Documentation
      • Start Here
      • Technical Documentation
      • Project Planning
  • Use Cases
    • Use Case Analysis
      • Purpose
      • User Personas
        • Privacy-Conscious Professional
        • Productivity Enthusiast
        • Accessibility User
        • Researcher/Interviewer
      • Primary Use Cases
      • Common Requirements Across All Use Cases
      • Integration Scenarios
        • With Other Applications
        • With AirGap Deploy
      • Out of Scope
      • Success Metrics
      • See Also
    • Use Case: Quick Voice Memo
      • Workflow
      • Success Criteria
    • Use Case: Meeting Notes
      • Workflow
      • Success Criteria
    • Use Case: Interview Transcription
      • Workflow
      • Success Criteria
    • Use Case: Accessibility - Hands-Free Text Input
      • Workflow
      • Success Criteria
  • Software Requirements Specification
    • Introduction
      • Purpose
      • Scope
      • Definitions
    • Overall Description
      • Product Perspective
      • Constraints
    • Functional Requirements
      • Recording
      • Transcription
      • History
      • Output
      • Settings
      • System Tray
      • Security
      • Deployment
    • Non-Functional Requirements
      • Performance
      • Reliability
      • Usability
      • Maintainability
      • Portability
      • Scalability
      • Security & Privacy
      • Deployment
    • Error Handling
    • Appendix: Default Hotkeys
  • Software Design Document
    • Introduction
    • Architecture Overview
      • System Context
      • Design Rationale
    • File Structure
    • Data Design
      • Database Schema
      • Settings Keys
      • Settings Validation
      • File Storage
      • Schema Migration Strategy
      • Data Retention Policy
    • Component Design
      • audio.rs
      • whisper.rs
      • db.rs
      • tray.rs
      • Tray Menu Structure
      • Tray Icon States
    • Interaction Flows
      • Record and Transcribe
      • Settings Dialog
      • First-Run Flow
      • History Dialog
    • Dependencies
    • Security & Privacy
    • Deployment
      • Air-Gap Support
      • Deployment Package
      • Platform Packages
      • Release Process
      • Code Signing
      • Distribution Channels
    • Platform Considerations
      • Build Requirements
      • Audio Backends
      • System Tray Behavior
      • Global Hotkeys
      • whisper.cpp
    • Localization Strategy
      • MVP Approach
      • Localization-Ready Architecture
      • Future Localization Approaches
      • Localization Priority
      • What NOT to Localize
  • Test Plan
    • Introduction
    • Test Strategy
      • Test Levels
      • Features Not Tested
      • Test Automation Approach
    • Test Cases by Category
      • Recording Tests
      • Transcription Tests
      • History Tests
      • Output Tests
      • Settings Tests
      • System Tray Tests
      • Security Tests
      • Deployment Tests
      • Non-Functional Tests
    • Test Procedures
      • Network Isolation Test (TC-SEC-003)
      • Offline Operation Test (TC-SEC-005)
      • Air-Gap Build Test (TC-DEP-002)
    • Pass/Fail Criteria

Planning

  • Project Roadmap
    • v1.0.0 Release
    • Current Status
    • MVP Scope
    • Implementation Milestones
      • Milestone 1: Skeleton
      • Milestone 2: Recording
      • Milestone 3: Transcription
      • Milestone 4: Persistence
      • Milestone 5: Hotkeys
      • Milestone 6: Polish
      • Milestone 7: Testing & Documentation
    • Definition of Done
    • What’s NOT in MVP
    • Key Documents
    • See Also
    • Progress Log

API Reference

  • API Reference
    • Planned Architecture
      • main.rs – Entry Point
      • audio.rs – Audio Capture
      • whisper.rs – Transcription
      • db.rs – Database
      • tray.rs – System Tray
    • Developer Resources
    • Future Enhancements
Cleanroom Whisper
  • Search

© Copyright 2026, Cleanroom Labs.