Ich schreibe ein klares Readme und einen Schnellstart für dein Python-Projekt
Forschungs- und Dokumentationssupport
Über diesen Service
Hilf neuen Nutzern, dein Python-Projekt zu verstehen und ihren ersten erfolgreichen Lauf abzuschließen.
Ich erstelle oder verbessere ein englisches README für ein kleines, öffentliches Python-Projekt: Zweck, Voraussetzungen, Einrichtung, ein Anwendungsbeispiel, erwartete Ausgabe, Konfigurationshinweise und Fehlerbehebung.
Der Basisumfang umfasst bis zu 800 Wörter, eine Markdown-Datei, eine Änderungszusammenfassung und Verifizierungshinweise. Umfang: bis zu 5 Quellcodedateien und 500 Zeilen Code, mit einem sicheren lokalen Test in einer vereinbarten Umgebung. Nicht verifizierte Schritte sind deutlich gekennzeichnet.
Mein Portfolio-Beispiel ist eigeninitiativ und KI-gestützt, kein Kundenprojekt. Die KI-gestützte Entwurfsarbeit wird anhand der bereitgestellten Quelle und erlaubter lokaler Tests überprüft.
Bitte schreibe zuerst mit dem öffentlichen Repository, Zielgruppe und exakter Version. Keine Geheimnisse oder privaten Kundendaten. Keine Code-Fixes, Live-Deployment, API-Referenzseite, bezahlte Abhängigkeiten, Sicherheitsüberprüfung oder zusätzliche Betriebssystemtests. Eine Revision deckt den vereinbarten Umfang ab; neue Funktionen benötigen ein separates Angebot.
Dokumenttyp:
Dokumentation
Sprache:
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
Wirst du meinen Code ändern oder einen Pull-Request veröffentlichen?
Nein. Dieses Paket liefert bearbeitbare Markdown- und Verifizierungshinweise. Code-Änderungen, Repository-Schreibrechte und Veröffentlichung sind separate Arbeiten.
Kannst du an privatem Code arbeiten?
Nicht im Rahmen dieses Starter-Pakets. Es ist auf öffentlichen Code und synthetische Beispiele beschränkt. Bitte sende keine Geheimnisse, private Repositories oder Kundendaten.
Garantierst du, dass die Software überall funktioniert?
Nein. Die Hinweise nennen die getestete Umgebung und unterscheiden verifizierte Verhaltensweisen von offenen Fragen. Dies ist keine Sicherheitsüberprüfung oder plattformübergreifende Zertifizierung.
Verwenden Sie KI?
Ja, für unterstütztes Entwerfen und Analysen, wo erlaubt. Aussagen werden anhand der Quelle und vereinbarter Tests überprüft. Dieser Service ist nicht geeignet für rein menschliche oder keine-AI-Anforderungen.
Was beinhaltet eine Revision?
Klarstellungen und Korrekturen innerhalb derselben vereinbarten Version, Dateien, Wortbegrenzung und Anwendungsfall. Zusätzliche Funktionen oder eine neue Version benötigen ein separates Angebot.
