Wie kann man ein schlechtes Projekt dokumentieren, ohne jemanden zu beschämen?

Ich habe an einem katastrophalen freiberuflichen Projekt voller Fehlentscheidungen teilgenommen. Ich habe es verlassen. Im Rahmen der Übergabe muss ich „meine Arbeit dokumentieren“, was im Wesentlichen bedeutet, dass ich das gesamte Projekt dokumentieren muss (ich bin der Erste, der irgendwelche Dokumente dazu geschrieben hat).

Jetzt muss ich erklären, wie die Dinge laufen, ihre Struktur, Architektur, Entwicklungsworkflows usw. Es ist voller Fehler. Jetzt, wo ich es schreibe, bin ich schockiert und auch überrascht.

Das professionelle Verhalten wäre, dass ich das Dokument einfach schreibe, ohne etwas zu erwähnen, was ich darüber denke. Das Problem ist nun, dass mein Name in diesem Dokument stehen wird und es daher so aussehen wird, als ob die schlechten Entscheidungen zumindest teilweise meine wären.

Natürlich könnte ich erklären, oder zumindest indirekt erwähnen, dass "nein, es war nicht meine Entscheidung". Ich könnte, aber es wäre offensichtlich höchst unprofessionell.

Ich könnte die Dokumente auch schreiben, ohne etwas über Verantwortlichkeiten zu sagen. Das Problem ist, dass es in diesem Fall auch meinen Namen beschämen würde. Ich kann auch vermuten, dass meine (Ex-)Kollegen dazu neigen würden, mich zu beschämen, anstatt ihre Fehler anzuerkennen. Aber ich kann natürlich auch ihren Namen nicht schämen.

Wie löst man diesen Widerspruch? Oder weiter gefasst: Was ist in einer solchen Situation der optimale, professionelle Weg?

Haben Sie diese Bedenken geäußert, als das Projekt lief? Wenn Sie zu diesem Zeitpunkt nichts unternommen haben, sind Sie an den Problemen mitschuldig und sollten genannt werden. Rückblick ist eine wunderbare Sache, aus der wir lernen können, aber den Finger der Schuld zuzuschieben, wenn Sie es einfach geschehen lassen, versucht, das Problem, zu dem Sie tatsächlich beigetragen haben, aus dem Gleichgewicht zu bringen.
Ich habe mich in der Vergangenheit davon abgewandt, Menschen die Schuld zu geben, indem ich Dinge gesagt habe wie; Einige geerbte Legacy-Codes entsprachen nicht den aktuellen Codierungsstandards:
Oder ; Aufgrund der verkürzten Integrationsphase konnten nicht alle geplanten Tests durchgeführt werden. Dito fehlende Testdaten. Kundenanforderungen kamen zu spät, um zufriedenstellend erfüllt zu werden. Zeitliche Engpässe führten dazu, dass die Personalkompetenzen nicht auf dem neuesten Stand waren. Diese Art von Sachen.

Antworten (3)

Ihre Dokumentation sollte zu 100 % neutral sein. Wie Sie bereits erwähnt haben, sollten Sie keinen Ihrer persönlichen Beiträge in die Dokumentation einbringen, z. B. wie Sie über das Projekt denken, Personen, die an dem Projekt gearbeitet haben, Designdetails usw Menschen, die an dem Projekt teilgenommen haben, wird es Ihnen gut gehen, da klar sein wird, dass Sie nicht derjenige waren, der die schlechten Entscheidungen getroffen hat.

Ihre neue Dokumentation kann ohne Nennung einer bestimmten Person erfolgen. Zum Beispiel könnte „Tom hat beschlossen, die Datenbanktabellen zu denormalisieren, um das Schreiben des Codes zu vereinfachen, aber am Ende wurde es unhandlich und schwer zu bearbeiten“ könnte umgeschrieben werden als „Die Entscheidung bezüglich der Datenspeicherung war, die Datenbank zu denormalisieren Tabellen, um die Menge an Code zu reduzieren, der auf der App-Seite geschrieben werden musste. Die Datenverwaltung wurde jedoch sehr schwierig, da es an guten Beziehungen und Strukturen zwischen den Daten und Tabellen mangelte.“ Auf diese Weise können Sie das Problem und das, was passiert ist, immer noch klar kommunizieren, ohne Schuldzuweisungen zu machen.

Die Schuldzuweisung erfolgt, wenn Sie E-Mails, Besprechungsprotokolle und alles andere bereitstellen, um eine Papierspur darüber zu erstellen, wie Entscheidungen getroffen wurden. Auch hier bleiben Sie als Dokumentationsverantwortlicher neutral, liefern aber relevante Informationen und lassen den Leser anhand des Inhalts zu logischen Schlüssen kommen. Wenn es eine E-Mail-Kette gibt, in der Sie mit einer Entscheidung nicht einverstanden sind oder nicht einmal Teil einer Entscheidung waren, die letztendlich fehlschlug, wird jeder, der die E-Mail liest, verstehen, dass es nicht Ihre Schuld war.

Normalerweise würden Sie Dinge sagen wie „Ich habe mich entschieden“, „Wir haben uns entschieden“, „Unser Teamleiter hat sich entschieden“. Wenn Sie sagen „die Entscheidung wurde getroffen, X zu tun“, oder „es wurde entschieden, X zu tun“, insbesondere wenn sich herausstellt, dass es eine schlechte Entscheidung war, sagt das ganz klar, dass Sie keine Namen nennen wollen, und dass Sie bestreiten, zu dieser Entscheidung beigetragen zu haben.

Sie dokumentieren das System so, wie es ist. Sie urteilen nicht darüber oder über diejenigen, die es geschrieben haben. Keine Sorge, wenn die Dokumentation klar genug ist, werden andere für Sie urteilen.

Wenn die App ordnungsgemäß in verschiedenen Versionen mit Datumsstempel gespeichert ist, sollte klar sein, dass Ihr Dokument erstellt wurde, lange nachdem das System "fertig" war. Wenn die App so groß ist, dass es mehrere Leute brauchte, um sie zu schreiben, dann sehe ich nicht, wie diese App an dich und nur an dich geheftet werden könnte.

Erledigen Sie Ihre Dokumentationsarbeit und vergessen Sie das Ganze. Eine Einschränkung: Achten Sie beim Dokumentieren darauf, dass Sie nicht „ich“ oder „wir“ verwenden.