Handbuch

[Safi105]

Da EEDC sehr umfangreich ist und ich mein System bevorzugt über die Home-Assistant-App steuere, wäre es hilfreich, wenn das Handbuch künftig vollständig oder zumindest in Teilen direkt in der App verfügbar wäre.

[supernova1963]

Hallo @Safi105, danke für die Anregung!

Kurze Rückfrage: Kennst du bereits die EEDC-Website unter https://supernova1963.github.io/eedc-homeassistant/? Dort findest du neben dem Benutzerhandbuch auch weitere Dokumentation zum Projekt.

Innerhalb der App gibt es bereits einige Hilfestellungen — der Setup-Wizard, der HA Sensor-Zuordnung Wizard und der Monatsabschluss-Wizard führen schrittweise durch die jeweiligen Prozesse, und an vielen Stellen gibt es Tooltips und erklärende Labels.

Kannst du konkretisieren, wo du dir mehr Hilfe wünschen würdest? Dann kann ich besser einschätzen, was sinnvoll wäre.

[Safi105]

Also der Link ist gut wäre noch besser in aus der App zu öffnen für leichtere Erreichbarkeit.

Ausserdem ein Banner mit dem man nach einem Update auf neue Funktionen aufmerksam gemacht wird. Beim darauf klicken wird man dann zur neuen Funktion geleitet. Da es in letzter Zeit schon viel Neuerungen gab. Ist es schwierig hier den Überblick zu behalten.

[supernova1963]

Hallo @Safi105,

kurze Rückmeldung: deine Anregung ist berechtigt — wer wie du primär in der HA-Companion-App arbeitet, hat aktuell keinen praktischen Weg zur Dokumentation, ohne die App zu verlassen. Externe Browser-Links helfen da wenig.

Mein Plan: in einem der nächsten Bündel kommt eine in-App-Hilfe-Seite, die den Inhalt aus dem Benutzerhandbuch direkt in der App rendert (eigene Route „Hilfe"). Damit funktioniert es in der HA-Companion-App identisch zum Browser, ohne Tab-Wechsel.

Bis es soweit ist: das vollständige Handbuch ist auf https://supernova1963.github.io/eedc-homeassistant/ zu finden — am Desktop oder im normalen Browser am Handy.

VG
Gernot

[supernova1963]

Hallo @Safi105,

Update zu beiden Punkten aus deinem Reply:

(1) In-App-Hilfe-Seite — seit v3.24.2 verfügbar

Top-Navigation → Eintrag „Hilfe" (oder direkt unter /hilfe). Acht kuratierte Dokumente in drei Kategorien — Einstieg (Übersicht + „Was ist neu", siehe unten), Handbuch (Installation / Bedienung / Einstellungen / Infothek), Referenz (Berechnungen / Sensor-Referenz / Glossar). Auf dem Smartphone als Dropdown, am Desktop als Sidebar. Alle Inhalte werden lokal gerendert — funktioniert in der HA-Companion-App identisch zum Browser, ohne Tab-Wechsel und ohne Ingress-Login-Stolpersteine. Direktlinks per ?doc=<slug> sind teilbar.

(2) What's-new-Banner — bewusst nicht gebaut, stattdessen „Was ist neu" als Hilfe-Seite (seit v3.24.5 heute)

Den Banner habe ich nach Abwägung verworfen. Begründung: HA-Add-on-Nutzer sehen den Changelog ohnehin schon im Add-on-Store beim Update, GitHub-Releases haben einen eigenen — ein zusätzlicher In-App-Banner wäre die dritte Stimme zur selben Information. Das wirkt schnell wie Meldungs-Spam, gerade wenn mehrere Updates kurz hintereinander kommen.

Stattdessen: ein fester Eintrag „Was ist neu" in der Hilfe-Sidebar (Einstieg → Was ist neu). Pro Version eine Sektion mit 3–5 anwender-perspektivisch formulierten Highlights und Deep-Links direkt in die zuständige Hilfe-Sektion. Chronologisch absteigend von v3.24 zurück bis v3.16. Pull statt Push: wer wissen will, was sich geändert hat, schaut rein — wer nicht, wird nicht behelligt.

Wenn dir das aktive Hinweisen nach einem Update fehlt, gib gerne Bescheid — bin offen für eine andere Lösung, will aber das „mehrfach dasselbe melden" vermeiden.

Schließe die Discussion sobald beide Seiten bei dir wie gewünscht funktionieren.