Diagnostics and Support

When diagnosing complex issues or reporting bugs, Kapinote provides a built-in, privacy-preserving diagnostic generator. Open Settings → Diagnostics, generate a report, inspect its contents, and attach it to your bug report or support email.

1. What the diagnostic report includes

• Kapinote app version and macOS architecture details (Apple silicon model, OS build)
• Status of macOS system permissions (Microphone, System Audio, Speech Recognition)
• Active speech and AI provider names and model IDs (all credentials automatically redacted)
• High-level telemetry for bug reproduction: meeting count, transcription latency, segment counts
• Recent sanitized application stack traces and error logs

2. Strict privacy guarantees: What is excluded

Kapinote's diagnostic engine enforces rigorous data masking by design:

• Zero API Keys: All API tokens, secret keys, and credentials are automatically stripped.
• Zero Raw Audio: Raw microphone or speaker audio files are never included.
• Zero Meeting Content: Meeting titles, transcript text, attendee names, and AI notes are completely excluded.
• Zero Chat Prompts: Prompts and user messages are excluded from the report.

Technical Context: To diagnose text parsing and formatting bugs without exposing the underlying text, reports only contain derived statistics (e.g., character counts, segment length distributions, language codes).

3. How to write an actionable issue report

When filing an issue on GitHub or reaching out via email, please provide:

1. Environment: Kapinote version and macOS version (e.g., macOS 15.1 on M3 Pro).
2. Expected vs. Actual: Clear description of what should have happened versus what occurred.
3. Reproduction Steps: Step-by-step actions to trigger the issue.
4. Provider Settings: Active speech engine and AI model names (without API keys).
5. Built-in Test: Whether the in-app provider test succeeded.
6. Attachment: Your reviewed, redacted diagnostic report.

4. Checklist before sharing

• Search the diagnostic text for internal company hostnames, corporate IP addresses, or personal emails.
• Ensure no private API keys are accidentally included in your issue description. If a key was exposed, immediately revoke it in your provider's console.
• Most common configuration issues can be solved immediately by consulting the Troubleshooting Guide.