Manual.md komplett neu: hochdetaillierte Referenz + PDF + Build-Pipeline
Manual.md ersetzt das bisherige kurze bilinguale Handbuch durch eine hochpräzise Anleitung: Kapitel 0-4/6-7 zitieren die tatsächlichen Tooltip-/Hilfetexte der App wörtlich (aus ConnectView, den Einrichten-Wizard-Schritten, DevicesView, BackupListView, OverviewView), Kapitel 5 (Experte-Feldreferenz, 44 Menüs/173 Felder) ist automatisiert aus RouterOSSchemaCatalog.swift geparst statt von Hand übertragen, kann also nie vom tatsächlichen App-Verhalten abweichen. Fünf Mermaid-Diagramme (Architektur, Verbindungs-/Vertrauens-Ablauf, Wizard-Schrittfolge, Fokus-Modus-Zustände, Sicherung/Wiederherstellung) als Quelle unter Manual-assets/diagrams/*.mmd, vorgerendert nach PNG. Echte App-Screenshots sind nicht möglich (keine macOS-UI-Automatisierung verfügbar) — im Manual selbst offen benannt statt stillschweigend ausgelassen. Neues build-manual.py regeneriert die Experte-Referenztabellen (zwischen festen Markern in Manual.md, Handschrift-Kapitel bleiben unberührt), rendert geänderte Diagramme neu und exportiert Manual.pdf über Markdown→HTML→headless Chrome print-to-pdf. README.md verweist auf beides. Künftig bei jeder Manual-Aktualisierung erneut laufen lassen, damit PDF und Referenztabellen nicht vom Quellcode abdriften. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
Binary file not shown.
|
After Width: | Height: | Size: 96 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 125 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 170 KiB |
@@ -0,0 +1,12 @@
|
||||
graph LR
|
||||
User["macOS-Nutzer"] --> App["RouterOS Assistant"]
|
||||
App --> T1["Verbinden"]
|
||||
App --> T2["Einrichten (Wizard)"]
|
||||
App --> T3["Übersicht"]
|
||||
App --> T4["LAN-Scanner"]
|
||||
App --> T5["Experte"]
|
||||
App --> T6["Sicherungen"]
|
||||
App -->|"bevorzugt"| REST["REST-API (/rest, HTTPS)"]
|
||||
App -->|"Fallback + Backup/Update/Firmware"| SSH["SSH"]
|
||||
REST --> Router[("MikroTik RouterOS Router")]
|
||||
SSH --> Router
|
||||
@@ -0,0 +1,9 @@
|
||||
flowchart TD
|
||||
A["Jetzt sichern"] --> B["Backup-Datei lokal gespeichert\n(wählbarer Speicherort)"]
|
||||
B --> C{"Was tun?"}
|
||||
C -->|"Wiederherstellen"| D{"Gleiches Routermodell?"}
|
||||
D -->|"Ja"| E["Upload per SFTP"]
|
||||
E --> F["Router spielt Backup ein\n(Login wird automatisch erhalten)"]
|
||||
D -->|"Nein"| X["Abgelehnt — Schutz vor Brick"]
|
||||
C -->|"Werkseinstellungen"| G["Automatisches Backup vorher"]
|
||||
G --> H["Kompletter Reset auf Werkszustand\nRouter startet neu, Verbindung geht verloren"]
|
||||
@@ -0,0 +1,13 @@
|
||||
flowchart TD
|
||||
A["Host, Benutzername, Passwort eingeben"] --> B{"Verbindungsweg"}
|
||||
B -->|"REST verfügbar (bevorzugt)"| C["REST: TLS-Zertifikat prüfen"]
|
||||
B -->|"REST nicht verfügbar"| D["SSH: Host-Schlüssel prüfen"]
|
||||
C --> E{"Zertifikat schon bekannt?"}
|
||||
E -->|"Nein, erste Verbindung"| F["Dialog: Vertrauen und verbinden"]
|
||||
E -->|"Ja"| G["Verbunden"]
|
||||
F --> G
|
||||
D --> H{"Host-Schlüssel schon bekannt?"}
|
||||
H -->|"Nein"| I["Dialog: Vertrauen und verbinden"]
|
||||
H -->|"Ja"| G
|
||||
I --> G
|
||||
G --> J["SSH-Host-Schlüssel zusätzlich im Hintergrund geprüft — für Backup, Update-Check, Firmware-Update, die immer SSH brauchen"]
|
||||
@@ -0,0 +1,7 @@
|
||||
stateDiagram-v2
|
||||
[*] --> Normal
|
||||
Normal --> Fokussiert: Klick auf Knoten
|
||||
Fokussiert --> Fokussiert: Klick auf anderen Knoten\nder gleichen Kette (Fokus wechselt)
|
||||
Fokussiert --> Normal: X-Button im Popup
|
||||
Fokussiert --> Normal: Klick auf leere Fläche
|
||||
Fokussiert --> Normal: erneuter Klick auf denselben Knoten
|
||||
@@ -0,0 +1,8 @@
|
||||
flowchart LR
|
||||
M["Modus wählen:\nEinfach oder Experte"] --> W["WAN\n(Internetanschluss)"]
|
||||
W --> L["LAN\n(ein oder mehrere Netzwerke)"]
|
||||
L --> V["VLAN\n(optional, zusätzliche Netzwerke)"]
|
||||
V --> Wi["WLAN\n(nur falls erkannt)"]
|
||||
Wi --> F["Firewall-Grundschutz"]
|
||||
F --> R["Review / Apply\n(jeder Befehl sichtbar, Auto-Backup vorher)"]
|
||||
R -->|"Jetzt anwenden"| D["Fertig"]
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 67 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
Reference in New Issue
Block a user