Ich schreibe ein klares Readme und eine Setup-Anleitung für dein Projekt

Einige Informationen wurden automatisch übersetzt.

Japan

Ich spreche Japanisch

Code Reviewer und Web App QA Spezialist

Ich überprüfe Python, FastAPI, TypeScript und KI-gestützten Code, teste Web-App-Flows und schreibe klare README- und Setup-Anleitungen. Du erhältst priorisierte Erkenntnisse, reproduzierbare Schritte,...
Über diesen Service

Kann ein neuer Beitragender dein Projekt starten, ohne zu fragen, was als Nächstes zu tun ist?


Ich werde dein Repository und verifizierte Setup-Schritte in ein klares README oder eine Setup-Anleitung umwandeln, die eine andere Person folgen kann.


Deine Dokumentation kann enthalten:

Zweck und Umfang des Projekts

Voraussetzungen und unterstützte Umgebung

Installationsschritte

Name der Umgebungsvariablen ohne geheime Werte

Ausführungs-, Build- und Testbefehle

Erwartete Verifizierungsergebnisse

Fehlerbehebungshinweise

Bekannte Einschränkungen und klar gekennzeichnete Unbekannte


Ich werde die bereitgestellten Anweisungen mit dem jeweiligen Projekt, soweit möglich, überprüfen und verifizierte Schritte von Annahmen trennen.


Bitte stelle das Repository oder relevante Dateien, dein aktuelles README falls vorhanden, die tatsächlichen Setup-, Lauf- und Testschritte, unterstützte OS- und Runtime-Versionen sowie das erwartete Ergebnis bereit. Entferne Passwörter, API-Schlüssel, persönliche Daten und alle anderen Geheimnisse vor dem Senden.


Dieser Service umfasst Dokumentation und begrenzte Verifikation. Er beinhaltet keine Produktionseinführung, vollständige Code-Refaktorisierung, eine formale Sicherheitsüberprüfung oder eine Garantie, dass jede Umgebung sich identisch verhält.

Dokumenttyp:

Benutzer- & Schulungshandbücher

•

Dokumentation

Sprache:

Englisch

•

Japanisch

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.

Mein Portfolio