Ich erstelle eine entwicklerfreundliche Codebasis-Dokumentation aus deinem Repository
App-, Automatisierungs- und Accessibility-Entwickler
Über diesen Service
Dein Code verdient klare Dokumentation. Ich lese dein Repository und schreibe eine knappe Entwicklerdokumentation basierend darauf, was der Code zeigt: README, Überblick zur Architektur, API- oder Modulreferenz und, im größten Paket, eine Onboarding-Anleitung für neue Entwickler.
Was du bekommst: ein README mit Installation, Konfiguration und Nutzung; einen Architekturüberblick mit leichten Mermaid-Diagrammen; eine Referenz für die wichtigsten Schnittstellen; und eine Onboarding-Anleitung (nur bei vollständigem Docs-Satz). Geliefert als Markdown-Dateien in einem gezippten Docs-Ordner über Fiverr, in Englisch oder Deutsch.
Der Leistungsumfang wird pro Paket durch Codegröße oder Anzahl der Module festgelegt. Ich dokumentiere, was aus dem Code hervorgeht, und ändere deinen Code nicht. Es gibt kein Laufzeit-Testing über das hinaus, was der Source zeigt, daher unklares Verhalten wird dir zur Bestätigung markiert.
Nur Projekte, zu deren Weitergabe du die Rechte hast. Bitte sende ein Zip-Archiv des Codes. Ich benötige nie Passwörter oder Schlüssel, und ich lasse Geheimnisse, die im Code gefunden werden, aus der Dokumentation heraus.
In Deutschland ansässig und gewohnt an datenschutzbewusste Zusammenarbeit. Deutsche Kommunikation jederzeit möglich.
Dokumenttyp:
Dokumentation
Sprache:
Englisch
•
Deutsch
Bevorzugte Lieferart
Bitte informiere den Freelancer über alle Präferenzen oder Bedenken in Bezug auf den Einsatz von KI-Tools bei der Ausführung und/oder Lieferung deines Auftrags.
FAQ
Automatische Übersetzung
Welche Sprachen und Tech-Stacks deckst du ab?
Die meistgenutzten Stacks funktionieren, einschließlich JavaScript, TypeScript, Python, Java, C#, PHP, Go und gängiger Frameworks. Teile deinen Tech-Stack und ich bestätige die Passung vor dem Start.
Wie werden Diagramme erstellt und in welchem Format?
Ich erstelle einfache Architektur- und Modul-Diagramme als Mermaid-Code, eingebettet in das Markdown. Sie werden auf GitHub und GitLab gerendert und später leicht bearbeitet.
Wie greife ich sicher auf meinen Code zu?
Sende ein Zip-Archiv des Codes über Fiverr. Teile keine Passwörter, Tokens oder privaten Schlüssel. Geheimnisse, die versehentlich im Code vorhanden sind, lasse ich in der Dokumentation außen vor.
Kannst du die Dokumentation nach der Lieferung aktualisieren?
Ja, du kannst später ein Update oder eine Erweiterung bestellen. Ich kann neue Dokumentation an Codeänderungen im vereinbarten Umfang anpassen.
Muss ich persönliche Daten oder Passwörter teilen?
Nein. Teile bitte nur geschäftsbezogene Informationen. Persönliche Passwörter benötige ich nie.
Können wir auf Deutsch kommunizieren?
Ja, gern. Ich bin in Deutschland ansässig und arbeite auch auf Deutsch oder Englisch. / Ich arbeite auf Deutsch und Englisch.

