Files
proxmox-selfservice/qa-tool/htdocs/README.md
Sven Steinert fce31ebcd7 Viel neues
2026-04-30 12:06:00 +02:00

86 lines
2.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# o-Byte QA Testprotokoll-Tool
Ein leichtgewichtiges Web-Tool für manuelle QA-Tests, entwickelt für kleine Teams.
Das Tool läuft **lokal im Browser** und benötigt keinen Server, keine Logins und keine Datenbank.
---
## Features
- **Vorlagen laden** (YAML oder JSON)
- **Steps dynamisch hinzufügen / löschen**
- Pflichtschritte 📌 markieren (mit Check, ob alle required Steps bearbeitet wurden)
- **Metadaten erfassen:** Modul, Modul-Version, PBX-Version, Tester, DocBee-URL
- **Ergebnis eintragen:** pass ✅, fail ❌, skip ⏭️, blocked ⛔
- **Evidenz-Links** hinterlegen (z. B. Screenshots, Tickets, Nextcloud-Dateien)
- **Exporte:**
- Markdown (`.md`)
- CSV (`.csv`)
- PDF (mit Logo, Farben, Emojis, klickbaren Links)
- YAML-Template (nur Vorlage ohne Testergebnisse)
- JSON (Lauf speichern und wieder laden)
- DocBee (Report als DocBee Nachricht posten)
---
## Installation & Nutzung
1. Repository klonen oder ZIP entpacken:
```bash
git clone <repo-url>
cd o-byte-qa-tool
```
2. Dateien liegen im Projektordner:
- `index.html`
- `style.css`
- `app.js`
- `logo.png` (für UI)
- `logo_light.png` (für PDF-Export)
- `favicon.ico`
3. Öffne `index.html` direkt im Browser (Doppelklick oder via `file://`).
4. Vorlage (`.yaml`) laden → Tests ausführen → Ergebnisse exportieren.
---
## YAML-Vorlage (Beispiel)
```yaml
name: "Modul XYZ Basis-Tests"
module: "Modul XYZ"
module_version: "1.2.3"
pbx_version: "8.1"
steps:
- id: "s1"
title: "Anruf initiieren"
expected: "Ruf wird erfolgreich aufgebaut"
required: true
- id: "s2"
title: "Rufumleitung"
expected: "Ruf wird korrekt umgeleitet"
required: false
```
---
## Exportformate
- **Markdown:** Übersicht für Doku oder Git-Repos
- **CSV:** Für Excel oder Datenanalyse
- **PDF:** Fertiges Protokoll (inkl. Logo, Farben, Emojis)
- **YAML:** Neue Testvorlage (nur Struktur, keine Ergebnisse)
- **JSON:** Gesamter Testlauf (inkl. Ergebnisse) → kann wieder eingelesen werden
---
## Hinweise
- Pflichtschritte sind mit 📌 markiert und müssen einen Status haben, sonst wird kein Export zugelassen.
- Evidenz-URLs können beliebige Links sein (http/https, Tickets, Dateien im Intranet).
- Alle Daten bleiben **lokal** im Browser; es gibt keinen Server und keine externe Speicherung.
- Getestet mit **Chrome** und **Edge**. Andere Browser funktionieren meist, sind aber nicht primär getestet.
---
## Lizenz
Interne Nutzung. Erweiterungen und Anpassungen nach Bedarf.