Zum Inhalt

Roadmap für Factsheet-Verbesserungen

Diese Roadmap dokumentiert den aktuellen Stand der Werkzeug-Factsheets und definiert Meilensteine zur Erreichung einer vollständigen und qualitativ hochwertigen Dokumentation gemäß GEMINI.md.

Status Quo

Nach einer automatisierten Analyse aller Factsheets wurden folgende Defizite identifiziert:

  • Gesamtanzahl Factsheets: 114
  • Factsheets mit Verbesserungsbedarf: 4
  • Hauptprobleme:
    • Platzhalter-Beschreibungen (Zweck-Sektion unvollständig)
    • Fehlende oder unzureichende Beispieldaten (weniger als 5 Beispiele)
    • Fehlende Verifizierung (Hashes) oder bekannte Installationsfehler
    • Minimale oder fehlende Validierungsschritte

Meilensteine

Meilenstein 1: Inhaltsvervollständigung (Content Completion)

  • Ersetzen aller Platzhalter-Texte ("ist ein Werkzeug für") durch präzise Beschreibungen des Werkzeugzwecks.
  • Ergänzung fehlender Metadaten wie Wikipedia-Links oder Referenzhandbücher, wo sinnvoll.

Meilenstein 2: Beispieldatensatz-Erweiterung (Example Richness)

  • Sicherstellung, dass jedes Factsheet mindestens 5-10 relevante Beispieldaten im examples/-Ordner enthält.
  • Dokumentation der Beispiele im jeweiligen README.md.

Meilenstein 3: Installations- und Validierungssicherheit (Deployment Confidence)

  • Behebung der in INSTALL_MISSING.md und FIXME.md gelisteten Probleme.
  • Generierung aller fehlenden .hash.sha256 Verifizierungsdateien nach erfolgreicher Testdurchführung.
  • Ausbau minimaler Validierungsschritte zu aussagekräftigen Funktionstests.

Detaillierte Verbesserungsliste

Gruppe Werkzeug Notwendige Verbesserungen
Bioinformatik bkchem Installation issue: Log-Fehler: ModuleNotFoundError, Python Traceback
Bioinformatik chemfig Installation issue: Log-Fehler: LaTeX Error
Cad-3d freecad Installation issue: In FIXME.md gelistet, Listed in FIXME.md
Testing schemathesis Installation issue: Log-Fehler: Fehlgeschlagen