Lernpfad und Themen öffnen
Vorlagen · Schritt 6 von 8

Projektwissen festhalten und Vorlagen nutzen

README, Projektblatt und KI-Anweisungen so führen, dass Ihr Team selbst weiterarbeiten kann.

Von Benjamin Stalder · Quellenstand 3. November 2026

Voraussetzung: Sie kennen Ihr Repository und können eine Textdatei bearbeiten.

Danach können Sie

Sie können das Wissen über Ihre Anwendung so ablegen, dass eine andere Person oder ein KI-Werkzeug sich orientieren kann. Sie erhalten frei verwendbare Textvorlagen. Passen Sie sie an Ihr tatsächliches Projekt an und entfernen Sie leere oder unpassende Abschnitte.

Vier nützliche Dateien

Datei Aufgabe Vorlage
README Einstieg: Zweck, Start, Prüfung und wichtige Links README-Vorlage
Projektblatt Zuordnung von Konten, Diensten, Umgebungen, Befehlen und Verantwortlichen Projektblatt-Vorlage
Projektanweisungen für die KI Vorgehen und Grenzen im konkreten Projekt AGENTS.md-Beispiel
.gitignore Neue lokale Dateien von Git ausschliessen Kleine Ausgangsvorlage

Sie können die Vorlagen in Ihren Projekten übernehmen und anpassen. Sie enthalten Platzhalter, keine funktionierende Einrichtung und keine Zugangsdaten. Öffnen und speichern Sie die Datei; legen Sie sie anschliessend mit dem richtigen Dateinamen im vorgesehenen Projektordner ab.

Eine brauchbare README

Schreiben Sie zuerst, welches Problem die Anwendung für wen löst. Ergänzen Sie dann die tatsächlich vorhandenen Voraussetzungen und Befehle: Welche Softwareversion wird gebraucht? Wie startet man lokal? Welche Prüfungen gibt es? Wie wird eine Vorschau erstellt? Wo steht der Veröffentlichungsweg?

Wenn Sie einen Befehl noch nicht eingerichtet oder ausprobiert haben, kennzeichnen Sie das. Ein erfundenes npm test hilft niemandem, wenn das Projekt kein entsprechendes Skript besitzt. Ein neutraler, wahrer Eintrag ist nützlicher: «Automatisierter Testbefehl noch nicht eingerichtet; nächster Schritt ist die Einrichtung für den Statusfilter.»

Verbindungen im Projektblatt festhalten

Notieren Sie den Eigentümer des Repositorys, seine Adresse, den lokalen Ordner und die verantwortliche Person. Ergänzen Sie die Test-/Produktionsumgebung, das Hosting und die Datenbank jeweils getrennt. Halten Sie fest, welches Ereignis eine Veröffentlichung auslöst und wo Geheimnisse verwaltet werden. Die geheimen Werte selbst gehören nicht in dieses Blatt.

Ein konkreter Auszug könnte lauten:

Repository: Kundenorganisation / Auftragsübersicht. Testdatenbank: separates Testprojekt. Produktivdatenbank: eigener Dienstzugang. Änderung beginnt auf einem Arbeitsbranch. Eine Veröffentlichung in den Betrieb wird erst über den vereinbarten Veröffentlichungsweg ausgelöst. Verantwortlich: benannte interne Ansprechperson und Vertretung.

Die tatsächlichen Namen, Adressen und Befehle werden für Ihre Anwendung eingetragen. So kann eine Anleitung zur allgemeinen GitHub-Einrichtung mit einem konkreten Projekt verbunden werden.

KI-Anweisungen verständlich formulieren

Halten Sie fest, welche Aufgabe die Anwendung erfüllt, welche Dateien wichtige Entscheidungen enthalten und welche vorhandenen Prüfungen benutzt werden. Eine gute Regel lautet zum Beispiel: «Ändere einen kleinen zusammengehörigen Teil. Erkläre die geänderten Dateien, führe die vorgesehenen Prüfungen aus und nenne verbleibende Unsicherheiten.»

Codex kann Projektanweisungen aus AGENTS.md berücksichtigen. Für andere Werkzeuge prüfen Sie die unterstützten Anweisungsdateien und deren Geltungsbereich in der jeweiligen Dokumentation. Eine solche Datei ersetzt keine technischen Zugriffsrechte. Offizielle OpenAI-Dokumentation zu AGENTS.md.

Wissen aktuell halten

Aktualisieren Sie die Anleitung zusammen mit der Änderung, wenn sich Start, Prüfung oder Veröffentlichung ändern. Halten Sie wichtige Entscheidungen mit Datum und Begründung fest: «Eigene Kundenkennung statt Firmenname als Verbindung, weil Namen geändert werden können.» Dadurch versteht eine spätere Person den Grund und kann eine Änderung sinnvoll beurteilen.

Sammeln Sie nicht einfach jeden Chatverlauf. Übernehmen Sie die geprüften Entscheidungen und Anweisungen, die später tatsächlich gebraucht werden.

Erfolgskontrolle

Eine andere Person kann anhand Ihrer Unterlagen den richtigen Ordner öffnen, den Startweg benennen und die vorgesehenen Prüfungen finden. Sie erkennt, welche Angaben geprüft und welche noch geplant sind. Das ist eine gute Grundlage für die erste KI-Änderung.