Ich schreibe ein klares Readme und einen Schnellstart für dein Python-Projekt

Einige Informationen wurden automatisch übersetzt.

Japan

Ich spreche Japanisch, Englisch

Forschungs- und Dokumentationssupport

Ich helfe dabei, Forschungs- und technische Informationen in klare, nutzbare Dokumentation umzuwandeln. Ich biete quellengesicherte Forschungsübersichten, Verbesserungen für Readme und Schnellstartanl...
Ü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.