Ich schreibe klare technische Dokumentation für deinen Code oder deine API

Guter Code mit schlechter Dokumentation wird aufgegeben. Deine Nutzer melden Probleme, die die Dokumentation hätte beantworten sollen, und du beantwortest die gleiche Frage jede Woche erneut.

Ich lese deinen tatsächlichen Code und schreibe Dokumentation, die genau beschreibt, was er wirklich macht, anstatt eine generische Vorlage mit deinem Projektnamen einzufügen.

WAS ICH SCHREIBE

Readme-Dateien, die jemanden in weniger als fünf Minuten zum Laufen bringen. API-Referenzen, die jeden Endpoint, Parameter und Fehler abdecken. Einrichtungsanleitungen, die auf einem sauberen Rechner funktionieren. Code-Beispiele, die so laufen, wie sie geschrieben sind. Troubleshooting-Abschnitte für die Fehler, die die Leute tatsächlich haben. Guides zum Mitwirken und Changelogs.

WIE ICH ARBEITE

Ich lese zuerst den Quellcode. Wenn der Code und deine Beschreibung nicht übereinstimmen, sage ich dir Bescheid. Dieses Missverhältnis ist meist ein Fehler, den es zu wissen gilt, und ich habe schon einige gefunden.

FORMATE

Markdown, reStructuredText, OpenAPI und Swagger, MkDocs, Docusaurus, reines HTML.

WAS DU BEKOMMST

Dokumentation, die zu deinem Repo passt, in deinem Format, bereit zum Commit. Quellcodedateien, damit du sie selbst pflegen kannst.

Sende einen Repo-Link oder deinen Code, und ich sage dir, was er wirklich braucht.