# teo230/betterstepsrecorder architecture

> Architecture diagram of the GitHub repository teo230/betterstepsrecorder, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-09-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/teo230/betterstepsrecorder
- Repository: https://github.com/teo230/betterstepsrecorder

## Overview

##### Project type and purpose
- This is a desktop-only, single-process Windows application (built on .NET 8, C# WinForms).
- Purpose: record user actions (screenshots + metadata) in real time and export them into various document formats (RTF, HTML, ODT, Obsidian).

##### File structure
- Top level: README, LICENSE, Docs, .gitignore, and src/BetterStepsRecorder solution.
- Within src/BetterStepsRecorder:
- Core folder (Program.* files) – recording engine, file I/O, image capture.
- Exporters folder – abstract base ExporterBase plus concrete exporters (Html, Obsidian, Odt, Rtf).
- UI files – MainForm, dialogs (ExportDialogs, FileNamePrompt, RestrictedFolderBrowser), HelpPopup.
- Helpers – FileDialogHelper, ShellExecuteHelper, ZipFileHandler, PictureBoxTools, WindowHelper.
- No web servers, no databases, no network. Everything is local.

##### README for insights
- Confirms real-time saving to prevent data loss
- Mentions features: start/pause recording, step list, editing text, exporting in multiple formats

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% UI Layer
    subgraph "UI Layer"
        direction TB
        MF["MainForm"]:::ui
        ED["ExportDialogs"]:::ui
        FNP["FileNamePrompt"]:::ui
        RFB["RestrictedFolderBrowser"]:::ui
        HP["HelpPopup"]:::ui
        SM["StatusManager"]:::ui
        SSE["StatusStripExample"]:::ui
        SSM["StatusStripManager"]:::ui
        PBT["PictureBoxTools"]:::ui
    end

    %% Core Engine
    subgraph "Core Engine"
        direction TB
        REC["RecordingEngine"]:::core
        IMG["ImageHandling"]:::core
        FOP["FileOperations"]:::core
    end

    %% Exporters Layer
    subgraph "Exporters"
        direction TB
        EB["ExporterBase"]:::exporters
        HE["HtmlExporter"]:::exporters
        OE["ObsidianExporter"]:::exporters
        OE2["OdtExporter"]:::exporters
        RE["RtfExporter"]:::exporters
    end

    %% Helpers / Utilities
    subgraph "Helpers / Utilities"
        direction TB
        FDH["FileDialogHelper"]:::helpers
        SEH["ShellExecuteHelper"]:::helpers
        ZFH["ZipFileHandler"]:::helpers
        WH["WindowHelper"]:::helpers
    end

    %% File System
    FS[("File System")]:::fs

    %% Relationships
    MF -->|"StartRecording() / PauseRecording() / SaveProject()"| REC
    ED -->|"Export()\"| EB
    EB -->|TemplateMethod| HE
    EB -->|TemplateMethod| OE
    EB -->|TemplateMethod| OE2
    EB -->|TemplateMethod| RE
    HE -->|"Generate HTML"| FS
    OE -->|"Generate Obsidian"| FS
    OE2 -->|"Generate ODT"| FS
    RE -->|"Generate RTF"| FS

    REC -->|"RecordEvent"| MF
    REC -->|"capture()"| IMG
    REC -->|"save()"| FOP
    IMG -->|"screenshot()"| FS
    FOP -->|"write project file"| FS

    MF -->|"OpenDialog() / SaveDialog()"| FDH
    MF -->|"ExecuteShell()"| SEH
    MF -->|"UI utilities"| WH
    REC -->|"File I/O support"| FDH
    REC -->|"ZIP support"| ZFH

    %% Click Events
    click MF "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/MainForm.cs"
    click MF "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/MainForm.Designer.cs"
    click MF "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/MainForm.resx"
    click MF "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/UI/MainForm/MainForm.RecordingOperations.cs"
    click MF "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/UI/MainForm/MainForm.FileOperations.cs"
    click MF "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/UI/MainForm/MainForm.ListBox_EventsOperations.cs"
    click MF "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/UI/MainForm/MainForm.ExportOperations.cs"
    click ED "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/UI/Dialogs/ExportDialogs.cs"
    click FNP "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/UI/Dialogs/FileNamePrompt.cs"
    click RFB "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/UI/Dialogs/RestrictedFolderBrowser.cs"
    click HP "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/HelpPopup.cs"
    click HP "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/HelpPopup.Designer.cs"
    click HP "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/HelpPopup.resx"
    click SM "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/UI/StatusManager.cs"
    click SSE "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/UI/StatusStripExample.cs"
    click SSM "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/UI/StatusStripManager.cs"
    click PBT "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/PictureBoxTools.cs"
    click REC "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/Core/Program.Recording.cs"
    click REC "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/RecordEvent.cs"
    click IMG "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/Core/Program.ImageHandling.cs"
    click FOP "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/Core/Program.FileOperations.cs"
    click EB "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/Exporters/ExporterBase.cs"
    click HE "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/Exporters/HtmlExporter.cs"
    click OE "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/Exporters/ObsidianExporter.cs"
    click OE2 "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/Exporters/OdtExporter.cs"
    click RE "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/Exporters/RtfExporter.cs"
    click FDH "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/FileDialogHelper.cs"
    click SEH "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/ShellExecuteHelper.cs"
    click ZFH "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/ZipFileHandler.cs"
    click WH "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/WindowHelper.cs"
    click FS "https://github.com/teo230/betterstepsrecorder/blob/main/src/BetterStepsRecorder/Properties/Resources.resx"

    %% Styles
    classDef ui fill:#ccffcc,stroke:#333,stroke-width:1px
    classDef core fill:#cce5ff,stroke:#333,stroke-width:1px
    classDef exporters fill:#fff2cc,stroke:#333,stroke-width:1px
    classDef helpers fill:#e0e0e0,stroke:#333,stroke-width:1px
    classDef fs fill:#ffd9b3,stroke:#333,stroke-width:1px
```
