Manuals

Sehr einfache Schritt-für-Schritt-Anleitungen mit typischen Fehlern, Lösungen und Glossar.

Manual-Vorlage für jedes Projekt

Lege pro Projekt eine eigene Manual-Datei im Ordner /manuals/ an. Verwende einfache Sprache, Screenshots und klare Warnhinweise.

Grundlagen

  1. Projekt öffnen.
  2. Kurzbeschreibung lesen.
  3. Systemanforderungen prüfen.
  4. Tool starten oder Download verwenden.
  5. Ergebnis prüfen und nicht blind übernehmen.

Tool starten

Browser-Tools können direkt geöffnet werden. Windows-/Java-/Python-Tools benötigen eventuell zusätzliche Laufzeitumgebungen. Trage die echten Anforderungen in jeder Projektseite ein.

Fehler melden

Beschreibe immer: Projekt, Version, Gerät, Browser, Betriebssystem, Schritte zum Nachstellen, erwartetes Ergebnis und tatsächliches Ergebnis.

Downloads prüfen

Downloads sollen mit Versionsnummer, Datum und SHA256-Prüfsumme veröffentlicht werden. So kann geprüft werden, ob die Datei unverändert ist.

Glossar

Beta: weitgehend nutzbar, aber noch nicht endgültig getestet. Alpha: frühe Testversion. Log: technisches Fehlerprotokoll. Export: Daten aus dem Tool speichern.