Dokumentation

Entdecken Sie

Erkundigen Sie sich beim Kunden nach seinen Zielen, Systemen, Regeln und Prozessen und tragen Sie die Antworten in ein Erfassungsdokument ein, das von allen späteren Schritten genutzt wird.

Ermitteln Sie vor der Änderung einer Einstellung, was der Kunde benötigt. Tragen Sie die Antworten in ein Dokument ein, das Erfassungsdokument. Alle späteren Schritte nutzen es, und die Übergabeanmerkung verweist darauf.

Mit wem man sprechen sollte

  • Die Person, die im Namen des Kunden entscheidet und für die Organisation in CoRoid verantwortlich ist.
  • Ein Engineering-Leiter für jedes Repository, in dem CoRoid arbeiten wird.
  • Die Personen, die heute Pull Requests prüfen und zusammenführen.
  • Sicherheit oder Compliance, wenn der Kunde Vorgaben zu Daten, Modellen oder Freigaben hat.
  • Der Verantwortliche für jeden Geschäftsprozess, den ein Workflow abdeckt.

Fragen, die man stellen sollte

Erfahren Sie nach Ergebnissen und Bedenken, nicht nach Einstellungen. Der Kunde sagt: „Niemand ändert den Zahlungscode ohne Prüfung.“ Die entsprechende Einstellung finden Sie später.

Ziele

  • Was muss nach 90 Tagen anders sein? Fordern Sie eine Messgröße und ihren aktuellen Wert an, zum Beispiel: „Fehler, die Berichte unterstützen, werden innerhalb einer Woche behoben.“
  • Welche Aufgaben muss CoRoid zuerst erledigen? Welche Aufgaben darf es niemals übernehmen?
  • Wer fordert heute Arbeit an? Wer wird CoRoid mit Aufträgen betrauen?

Systeme

  • Welcher Git-Host und welche Repositorys? Kann CoRoid den Git-Host über das öffentliche Internet erreichen?
  • Wie wird in jedem Repository gebaut und die Tests ausgeführt? Welche Dienste werden für die Tests benötigt?
  • Wie melden sich die Nutzer heute an? Nutzt das Unternehmen einen Identitätsanbieter, der mit SSO kompatibel ist?
  • Welches Chat-Tool verwendet das Team?
  • Wo kommen die Aufträge heute her: aus einem Issue-Tracker, einem Fehler-Tracker, einem Support-E-Mail-Postfach oder einem Monitoring-Tool?
  • Welche internen Systeme müssen die Agenten lesen oder ändern können? Gibt es dafür einen MCP-Server?
  • Wie gelangt der Code in die Produktion? Wer führt die Bereitstellung durch und an welchen Tagen?

Regeln

  • Wo müssen die Daten bleiben? Müssen Anfragen an AI-Modelle innerhalb der EU erfolgen?
  • Welche Modell-Anbieter sind zugelassen? Hat der Kunde eigene Verträge und Schlüssel bei den Modell-Anbietern?
  • Welcher Code benötigt vor dem Zusammenführen die Freigabe einer bestimmten Person? Wer gibt die Freigabe?
  • Was muss jede Änderung durchlaufen: Tests, Abdeckung, Sicherheitsscans, Übersetzungen?
  • Was darf CoRoid ohne menschliches Eingreifen starten? Wie viel darf es pro Woche oder Monat ausgeben?
  • Was muss das Audit-Protokoll aufzeichnen und wie lange muss es aufbewahrt werden?

Prozesse

  • Welche Geschäftsprozesse kann ein Workflow abdecken? Für jeden Prozess: Wie beginnt ein Fall, welche Schritte gibt es und welche Entscheidungen erfordern ein menschliches Eingreifen?
  • Welche Regeln bestimmen den Rest? Formulieren Sie sie als Zeilen: „Wenn dies, dann jenes“.
  • Was muss geschehen, wenn etwas fehlschlägt – zum Beispiel eine fehlgeschlagene Aufgabe oder eine fehlgeschlagene Bereitstellung?
  • Welche Aufgaben müssen nach einem Zeitplan ausgeführt werden, zum Beispiel eine wöchentliche Bereinigung?

Personen

  • Wer sind die Inhaber und Administratoren? Wer fordert Arbeit an und wer prüft nur?
  • Wer pflegt die Einrichtung nach der Übergabe?

Das Erfassungsdokument

Halten Sie das Dokument kurz. Verwenden Sie diese Abschnitte in dieser Reihenfolge.

  1. Ziele. Die Ergebnisse nach 90 Tagen, jeweils mit einer Messgröße und ihrem aktuellen Wert.
  2. Systeme. Der Git-Host und die Repositorys, die Anmeldung, das Chat-Tool, Issue- und Fehler-Tracker, interne Tools sowie der Weg zur Produktion.
  3. Regeln. Wo die Daten bleiben, zugelassene Modelle, Freigaben, die Prüfungen, die jede Änderung durchlaufen muss, Budgets, Audit und Aufbewahrung.
  4. Abzudeckende Prozesse. Für jedes Projekt und jeden Workflow: was er abdeckt, wer ihn verantwortet und wie Sie feststellen, dass er funktioniert.
  5. Personen. Die Rolle jeder Person in CoRoid sowie wer die Einrichtung nach der Übergabe pflegt.
  6. Offene Fragen. Was der Kunde noch entscheiden muss und bis wann.

Für jede Regel notieren Sie, wo sie eingestellt wird. Konfigurieren listet alle Orte auf. Eine Regel, die keine Einstellung abdeckt, ist eine Anfrage an CoRoid. Sehen Sie Ein Bedarf, den nichts abdeckt.

Fertiggestellt, wenn

Der Kunde liest das Dokument und stimmt ihm zu. Von da an wird eine Planänderung zuerst ins Dokument eingetragen und anschließend in die Einstellungen übernommen.