Ich erstelle dir ein klares Readme und Setup-Guide für dein Webprojekt
Website-Audits mit Web- und SEO-Erfahrung seit 2020
Über diesen Service
Gib Entwicklern einen klaren Startpunkt für dein kleines Webprojekt.
Ich dokumentiere ein vereinbartes Projekt mit bis zu 5 relevanten Quell-/Konfigurationsdateien und insgesamt 500 nicht-leeren Zeilen. Jede Package-Stufe verwendet denselben Codeumfang; höhere Stufen erweitern die Dokumentationstiefe.
Basic: Readme bis zu 800 Wörter, Voraussetzungen, Setup, ein Anwendungsbeispiel und Verifikationshinweise.
Standard: Bis zu 1.400 Wörter verteilt auf Readme und Troubleshooting-Hinweise, mit bis zu 3 vereinbarten Anwendungsbeispielen.
Premium: Bis zu 2.000 Wörter über Readme, Setup/Fehlersuche und Entwicklendenhandbuch, mit bis zu 5 vereinbarten Beispielen.
Ich prüfe Behauptungen gegen die gelieferte Version und verifiziere sichere, vereinbarte lokale Schritte in einer Umgebung. Nicht verifizierte Schritte und fehlende Voraussetzungen sind deutlich markiert. Deliverables sind bearbeitbare Markdown-Dateien.
KI unterstützt beim Entwerfen; ich validiere die Dokumentation manuell. Zugangsdaten, personenbezogene Daten, Quellcode und vertrauliches Material werden nicht ohne schriftliche Einwilligung an KI-Tools gesendet.
Kein Code-Fixing, kein Deployment, keine Payed Services, kein Security-Audit oder komplette API-Referenz-Seite. Schick vor der Bestellung den Projektumfang und Stack. Englisch oder Niederländisch; eine begrenzte Überarbeitung.
Dokumenttyp:
Dokumentation
Branche:
Software
Sprache:
Niederländisch
•
Englisch
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
Wie groß kann mein Projekt sein?
Alle Pakete decken ein Projekt mit bis zu 5 relevanten Quell-/Konfigurationsdateien und insgesamt 500 nicht-leeren Zeilen ab. Vendor-, generierte und minifizierte Dateien werden nicht überprüft. Höhere Pakete erhöhen die Dokumentationstiefe, nicht die Repository-Größe. Schick zuerst die Dateiliste und den Stack, damit ich die Passung bestätigen kann.
Was beinhalten die Wort- und Beispielgrenzen?
Basic umfasst ein Readme bis 800 Wörter und ein Anwendungsbeispiel. Standard umfasst bis zu 1.400 Wörter insgesamt und 3 Beispiele. Premium umfasst bis zu 2.000 Wörter insgesamt und 5 Beispiele. Das sind Obergrenzen, keine Füllziele; die Dokumente können kürzer sein, wenn es das Projekt klar erklärt.
Wirst du mein Projekt ausführen oder eine Programmiersprache dokumentieren?
Wir einigen uns zunächst auf einen unterstützten Stack, eine Version und eine lokale Umgebung. Ich prüfe sichere Schritte im Rahmen; kein unsicherer Code, keine Secrets oder Payed Services. Fehlende Abhängigkeiten und unbestätigte Schritte werden klar aufgezeichnet. Ich verspreche nicht jede Technologie oder jedes Betriebssystem.
Wirst du Bugs beheben, das Projekt deployen oder eine vollständige API-Dokumentation schreiben?
Nein. Ich dokumentiere die vereinbarte Version und liefere Verifikationshinweise. Code-Reparaturen, Features, Deployment, Produktionszugang, vollständige API-Referenzseiten, Sicherheitsprüfungen und zusätzliche Umgebungen sind ausgeschlossen. Bestehende Probleme können dokumentiert werden, ohne zu behaupten, dass sie behoben wurden.
Kannst du privaten Code verwenden, und benutzt du KI?
Teile nur autorisierten Code und entferne Secrets sowie personenbezogene Daten. KI kann beim Entwurf helfen; ich validiere die Dokumentation manuell gegen den Quellcode und zugelassene Tests. Quellcode und nicht-öffentliche Materialien gehen ohne schriftliche Einwilligung nicht an externe KI. Vereinbare zuerst den Umgang mit vertraulichem Material.
Welche Dateien, Sprachen und Überarbeitungen erhalte ich?
Bearbeitbare Markdown-Dateien, eine Änderungsübersicht und Verifikationshinweise, in Englisch oder Niederländisch. Eine Überarbeitung deckt Korrekturen oder Klarstellungen zur Originalfassung, Dateien, Beispiele und Umgebung ab. Neue Versionen, Features oder Umgebungen benötigen eine gesonderte Vereinbarung.

