README: ChatGPT übernimmt die Dokumentation

Die Dokumentation für kleine bis mittelgroße Projekte zu schreiben, ist Zusatzarbeit, die man gerne abgeben möchte. Nach der Veröffentlichung der OpenAI-API lag es also auf der Hand, dass man ChatGPT für die Aufgabe abstellen könnte. Das kleine, treffend betitelte Tool codex-readme verspricht genau das: Es schaut sich die Programmdateien des jeweiligen Projekts an und verkettet sie zu einem großen Prompt, das von ChatGPT dann in die Form einer readme.md-Datei gebracht wird.

Das Programm ist komplett in Python geschrieben und benötigt das openai-Modul sowie argparse und configparser. Zudem ist ein Zugriff auf die Codex-API nötig. Die Nutzung der Schnittstelle kostet allerdings ein paar Cent – den entsprechenden Schlüssel erhält man über einen Account auf OpenAI. Informationen und Bibliotheken zu Codex finden sich außerdem auf der Seite lablab.ai – auf der außerdem eine Menge anderer spannender Projekte vorgestellt werden, die die API einsetzen. Dank der MIT-Lizenz lässt sich das Tool auch völlig frei verwenden.

Interessierte finden codex-readme auf GitHub. Das Tool setzt an der Stelle an, wo heutige Sprachmodelle besonders glänzen können: Stupide Schreibarbeiten, für die ein generisches Verständnis der Inhalte notwendig ist. Jetzt, da die Modelle innerhalb weniger Jahre erheblich mächtiger geworden sind – zurzeit steht GPT-4 vor der Tür – müssen diese Sweetspots nur noch aufgedeckt werden.

Siehe auch:

• ChatGPT bei heise Download

(kki)