Ich lese zuerst deinen Code, dann schreibe ich die Dokumentation
Python-Entwickler, Windows-Desktop-Apps, KI-Tools
Über diesen Service
Die meisten README-Dateien werden von der Person geschrieben, die bereits weiß, wie das Projekt funktioniert – genau die falsche Person dafür.
Ich lese zuerst deinen Code, dann schreibe ich die Dokumentation basierend auf dem, was er tatsächlich macht, nicht auf das, was du mir darüber erzählt hast.
Was du bekommst:
- Ein README, dem jemand folgen kann, ohne dich zu fragen: Was ist das, was braucht es, wie läuft es, und was geht zuerst schief.
- Ein CHANGELOG, das wie eine Liste der Unterschiede liest, nicht wie eine Liste der geänderten Dateien.
- Setup- oder API-Dokumentation, falls dein Projekt das braucht, mit getesteten Befehlen statt vermuteter.
- Eine Notiz am Ende, die dir sagt, welche Teile deines Codes ich nicht herausfinden konnte, denn das sind meistens die Teile, die deine Nutzer auch nicht verstehen.
Was ich dazu bringe: 23 technische Guides auf meiner eigenen Seite, 46 Seiten auf Englisch und Polnisch, 53.700 Wörter. Neun Artikel auf HackerNoon, einer davon auf Platz eins der Trending-Liste und vom Redakteur selbst im Newsletter erwähnt.
Englisch oder Polnisch. Schick mir ein Repository und sag mir, wer es lesen soll.
Dokumenttyp:
Benutzer- & Schulungshandbücher
•
Dokumentation
Branche:
Software
Sprache:
Englisch
•
Polnisch
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
FAQ
Automatische Übersetzung
Muss ich dir mein Projekt zuerst erklären?
Nein. Schick mir das Repository. Wenn ich aus dem Code nichts herausfinden kann, ist das eine Information, die es wert ist, festgehalten zu werden, und kommt in den Bericht.
Kannst du es auch auf Polnisch schreiben?
Ja, beides, und die beiden Versionen sagen dasselbe, anstatt eine Übersetzung zu sein, die abdriftet.
Mein Projekt ist unfertig. Ist das ein Problem?
Nein, aber sag es, und ich schreibe eine Dokumentation, die ehrlich ist über das, was noch nicht gebaut ist, anstatt etwas zu versprechen.

