FAQ von Swimm
Was ist Swimm?
Swimm ist ein KI-gestütztes Tool zur Dokumentation von Code, das nahtlos in Ihre IDE integriert wird. Es generiert interaktive Dokumentstrukturen basierend auf dem Kontext Ihres Codes, was es einfacher macht, umfassende Code-Dokumentationen zu erstellen.
Wie benutzt man Swimm?
Um Swimm zu verwenden, installieren Sie das IDE-Plugin für Ihre bevorzugte integrierte Entwicklungsumgebung (IDE). Nach der Installation kann Swimm AI Ihren Code analysieren und Dokumentstrukturen vorschlagen. Sie können auch den Befehl /generate verwenden, um mühelos Code-Erklärungen zu Ihren Dokumenten hinzuzufügen. Swimm AI kann Sichtbarkeitsregeln für Dokumente basierend auf Anwendungsfällen festlegen und sogar Dokumentationen aus einem Pull Request (PR) generieren.
Wie funktioniert Swimm AI?
Swimm AI analysiert Ihren Code und schlägt Dokumentstrukturen basierend auf dem Kontext des Codes vor. Es kann auch automatisch Code-Erklärungen generieren, Sichtbarkeitsregeln festlegen und Dokumentationen aus PRs erstellen.
Ist meine Daten bei Swimm sicher?
Ja, Swimm verschlüsselt und sichert Ihre Dokumente und Ihren Code gemäß seiner Standard-Sicherheits- und Datenschutzrichtlinie. Die an OpenAI zur KI-Verarbeitung gesendeten Daten werden nicht verwendet, um das Modell von OpenAI zu trainieren oder zu verbessern.
Welche IDE-Integrationen bietet Swimm an?
Swimm bietet IDE-Plugins für beliebte integrierte Entwicklungsumgebungen wie VS Code und JetBrains an.
Wie kann Swimm den Dokumentationsworkflow meines Teams verbessern?
Swimm erleichtert die Erstellung umfassender Code-Dokumentationen, verbessert die Zusammenarbeit und das Verständnis, verhindert wiederkehrende Fehler und integriert sich nahtlos in bestehende Entwicklungs-Workflows.