Häufige Fragen (FAQ)

QuantalQ Doc

Antworten auf deine Fragen zur Nutzung der Dokumentaions-Applikation

Funktionen & Integrationen

Unsere Dokumentationem sind an den Standard ISO/IEC 26515:2018 (Entwicklung von Informationen für Anwender in einer agilen Umgebung) angelehnt strukturiert. Sie gewährleistet Klarheit, Konsistenz und Benutzerfreundlichkeit. Die Inhalte werden als gut organisiertes, leicht navigierbares PDF bereitgestellt, die sowohl technische als auch nicht-technische Leser mit den relevanten Informationen unterstützt.

Um komplexe Prozesse verständlich darzustellen, enthalten wir hilfreiche PlantUML-Diagramme wie Systemarchitektur-Übersichten, Prozessabläufe, Datenbeziehungsmodelle und Sequenzdiagramme. Gemäss ISO/IEC 26515:2018 legen wir den Fokus auf aufgabenorientierte Inhalte, klare visuelle Anleitungen und strukturierte Informationen, die alle Leser während ihrer gesamten Nutzung begleiten.

Wir unterstützen alle GIT-Repositories, solange diese über das Internet erreichbar sind und sich mittels API-Token verbinden lassen. Dazu gehören gängige Plattformen wie GitHub, GitLab, Bitbucket sowie andere Anbieter, die standardmässigen GIT- und API-Zugriff bereitstellen.

Konten & Login

Aktuell besteht der einzige Unterschied darin, dass du bei einem Organisation-Account deine Firmendaten hinterlegen kannst, was ausschliesslich für vertragliche Zwecke erforderlich ist.

In Zukunft wird der Organisation-Account zusätzlich die Möglichkeit bieten, weitere Mitarbeitende deines Unternehmens einzuladen und zu verwalten, sodass mehrere Teammitglieder Projekte unter demselben Organisation-Account erstellen und ausführen können.

Wir nehmen Security ernst. Ein Benutzername und ein Passwort allein bieten heutzutage keinen ausreichenden Schutz mehr. Die Informationen, die du mit uns teilst, verdienen den bestmöglichen Schutz.

Deshalb ist die Zwei-Faktor-Authentifizierung (2FA) bei uns verpflichtend – sie ergänzt den Login um eine zusätzliche Sicherheitsebene und schützt deine Daten vor unbefugtem Zugriff.

Noch nicht, aber wir planen bereits die Anmeldung per Passkey künftig als zusätzliche Option einzuführen. So wirst du dich noch sicherer und komfortabler anmelden können.

Dokumentationsprojekt

Ein Projekt definiert, welches Produkt-Repository automatisch dokumentiert werden soll.

Du wählst ein Repository und einen Branch als Input aus. Das Resultat ist immer eine aktuelle, automatisch erstellte Dokumentation.

Ein Projekt kann manuell mit einem einzigen Klick oder automatisch** ausgeführt werden, zum Beispiel nach einem Zeitplan oder ausgelöst durch bestimmte Ereignisse. In beiden Fällen wird die Dokumentation vollständig automatisch erstellt – ohne dass du manuell eingreifen musst.

** demnächst verfügbar

Aktuell bieten wir keine Editor-Funktion an. Bis der Service verfügbar ist, kann das QuantalQ Team auf Anfrage aber Anpassungen machen die auch bei den nächsten Dokumentationesversionen wieder berücksichtigt werden.

Um dein Code-Repository zu verbinden, musst du einen persönlichen API-Token (auch Personal Access Token genannt) bei deinem Git-Anbieter erstellen. Dieser Token ermöglicht einen sicheren Zugriff, ohne Benutzername und Passwort zu verwenden.

Hier kannst du je nach Anbieter deinen API-Token erstellen:

Sobald der Token erstellt ist, kopierst du ihn einfach und fügst ihn auf der Projekt-Erstellungsseite im QuantalQ Doc Customer Portal in das entsprechende Feld ein. Achte darauf, deinen Token sicher aufzubewahren, da er direkten Zugriff auf deine Repositories ermöglicht.

Preise & Bezahlen

Wir bieten keinen Freemium-Plan an. Allerdings stellen wir dir eine flexible Pay-as-you-go-Option zur Verfügung, mit der du QuantalQ Doc zu geringen Einstiegskosten testen kannst – ohne direkt ein vollständiges Abonnement abschliessen zu müssen.

Es fällt dabei eine kleine Grundgebühr an, aber du behältst jederzeit die volle Kontrolle über deine Nutzung und deine Kosten.

Aktuell bieten wir keine Online-Zahlung an. Stattdessen stellen wir Rechnungen aus, die du bequem per Banküberweisung oder gemäss den vereinbarten Zahlungsbedingungen begleichen kannst.

Für eine persönliche Beratung oder ein individuelles Angebot kannst du dich jederzeit gerne an unser Sales-Team wenden.
sales@quantalq.com

Nach oben scrollen