Dokumentation
Guter Code verdient eine gute Erklärung.
Das Feature ist gebaut. Jetzt soll es verständlich, nutzbar und übergabefähig sein. Lurus Code liest dein Projekt und hilft, aus Implementierungsdetails Dokumentation, Diagramme und Release Notes zu machen.
Nutze die Befehle im Lurus-Code-Chat in deinem Projekt. /docs ist ab Pro verfügbar. KI-Nutzung hängt von deinem Plan und Guthaben ab.
Für den nächsten Leser
Vom Einstieg bis zur API.
Nicht jeder Leser braucht jedes Detail. Starte mit einer Datei, erweitere auf ein Modul oder frage nach einem Projektüberblick. Der Agent liest den relevanten Code, bevor er die Dokumentation schreibt.
-
Ein Einstieg ins Projekt.
Erkläre die Projektstruktur und die Rolle ihrer wichtigsten Teile. Gib dem nächsten Entwickler einen Ausgangspunkt statt eines weiteren Ordners zum Durchsuchen.
-
Nutzbare Schnittstellen.
Dokumentiere öffentliche Funktionen, Klassen und Typen: ihren Zweck, die erwarteten Parameter und die Rückgabewerte.
-
Beispiele mit Kontext.
Lass dir Anwendungsbeispiele und Erklärungen zur Schnittstelle erstellen. Prüfe, ob sie zum aktuellen Code und zum gewünschten Verhalten passen.
Verbindungen sichtbar machen
Ein Ablauf wird klarer, wenn man ihn sehen kann.
Beschreibe den Zusammenhang, den du erklären möchtest. /mermaid liest die relevanten Dateien und erstellt Mermaid-Code für Architektur, Datenmodelle oder Interaktionen. Ergänze ihn in deiner Dokumentation und rendere ihn mit einem Mermaid-kompatiblen Viewer.
- Einen Authentifizierungsablauf erklären
/mermaid auth flow
Prüfe die Beziehungen und rendere das Diagramm vor der Weitergabe. Die erstellte Syntax ist ein Ausgangspunkt, keine verifizierte Architekturkarte.
Den Kreis schließen
Commits halten Änderungen fest. Release Notes erklären sie.
/changelog nutzt Commits seit dem letzten Git-Tag für einen Entwurf im Keep-a-Changelog-Format. Neue, geänderte und korrigierte Funktionen werden leichter erfassbar als eine Liste von Commit-Nachrichten.
- Einen Changelog-Eintrag vorbereiten
/changelog
Benötigt eine lesbare Git-Historie. Ohne Tag versucht der Befehl einen Bereich von 20 Commits. Prüfe Version, Release-Umfang und Formulierungen vor der Veröffentlichung.
Git & GitHubHalte die Erklärung nah am Code.
Erstellte Dokumentation ist ein Entwurf, kein automatischer Hintergrundabgleich. Fordere nach relevanten Änderungen ein Update an, prüfe den Diff und halte die freigegebenen Dateien im Repository.
- Dokumentation mit der Implementierung abgleichen.
- Beispiele, Diagramme und Release-Details prüfen.
- Geprüfte Dokumentation mit der zugehörigen Änderung committen.
Eine Datei. Ein erster guter Entwurf.
Öffne den Lurus-Code-Chat im Projekt und ersetze den Beispielpfad durch deine eigene Datei. /docs schreibt Dokumentation und berichtet, welche Dateien und öffentlichen Schnittstellen dokumentiert wurden.
CLI einrichten- Eine Quelldatei dokumentieren
/docs src/auth.ts
Dein Code bleibt dein Code.
Quellcode und Anfragekontext werden mit Zero Data Retention verarbeitet. Keine Nutzung für Modelltraining. Provider und Verarbeitungsregion sind transparent ausgewiesen.
Datenschutz und Verarbeitung ansehenGut zu wissen, bevor du startest.
Was erstellt /docs?
Bleibt die Dokumentation automatisch aktuell?
Werden Diagramme und Release Notes automatisch veröffentlicht?
Dokumentation
Mach deine nächste Änderung verständlicher.
Starte mit einem Modul, zu dem dein Team häufig Fragen stellt. Erstelle einen ersten Entwurf, gleiche ihn mit dem Code ab und mache daraus etwas, das dem nächsten Leser hilft.
Für Pro, Pro+ und Ultra. Danach kostenpflichtig, sofern du nicht vorher kündigst. Nutzung und Funktionen hängen von deinem Plan und Guthaben ab.
Du möchtest mit deinem Team starten? Sprich mit uns.