Ich werde deine Software mit Architekturdiagrammen und Swagger OpenAPI-Dokumenten dokumentieren
Full-Stack-Entwickler
Über diesen Service
Mache deine Software leichter verständlich, wartbar und an andere Entwickler zu übergeben. Ich verwandle deinen Quellcode und Projektinformationen in klare technische Dokumentation, nutze KI-gestützte Analyse und überprüfe sie anhand der bereitgestellten Materialien.
BASIC: 1 Modul, Projektübersicht, Struktur, Einrichtungsanleitung und 1 Architekturdiagramm. Lieferung im Markdown-Format.
STANDARD: bis zu 3 Module, Schlüssel-Workflows und Datenmodell, bis zu 3 Diagramme und Swagger/OpenAPI für 10 Endpunkte. Markdown und PDF.
PREMIUM: bis zu 6 Module, detaillierte Workflows und Datenmodell, bis zu 6 Diagramme und OpenAPI für 25 Endpunkte. Setup-/Bereitstellungsanleitung basierend auf deiner bereitgestellten Umgebung. Markdown, PDF und bearbeitbare Diagrammquellen.
Ein Modul ist ein vereinbarter funktionaler Bereich, wie Authentifizierung oder Zahlungen. Ein Endpunkt ist eine HTTP-Methode plus Route. Alle Grenzen gelten zusammen für ein Repository und eine vereinbarte Codeversion.
Revisionen decken Korrekturen innerhalb des vereinbarten Umfangs ab. Neue Funktionen, Codeänderungen, Laufzeittests und laufende Updates erfordern ein separates Angebot. Bitte kontaktiere mich vor der Bestellung bei großen oder komplexen Projekten.
FAQ
Automatische Übersetzung
Was brauchen Sie für den Anfang?
Stelle den Quellcode oder das Repository, die Sprache/Framework, die vereinbarte Codeversion, die Anzahl der Module und Endpunkte, die Zielgruppe und verfügbare Setup-/Bereitstellungsinformationen bereit. Entferne Passwörter, API-Schlüssel und persönliche Daten vor dem Teilen.
Verwendest du KI, um die Dokumentation zu erstellen?
Ja. Ich nutze KI-gestützte Analyse, um die Dokumentation vorzubereiten und sie anhand des Codes und der von dir bereitgestellten Informationen zu überprüfen. Fehlendes oder unklar beschriebenes Verhalten wird zur Klärung markiert. Laufzeittests sind ein separater Service.
Was zählt als Modul oder Endpunkt?
Ein Modul ist ein vereinbarter funktionaler Bereich, wie Authentifizierung oder Zahlungen. Ein Endpunkt ist eine HTTP-Methode und Route. Paketgrenzen gelten zusammen für ein Repository und eine Codeversion. Größere Systeme benötigen ein individuelles Angebot.
Was ist in Revisionen enthalten?
Revisionen umfassen Korrekturen und Klarstellungen innerhalb des vereinbarten Umfangs und der Codeversion. Neue Module, Funktionen, Codeänderungen, zusätzliche Endpunkte oder laufende Dokumentationsupdates erfordern ein separates Angebot.

