Steht die Struktur des Wikis fest, ist das ein wichtiger Schritt. Allerdings muss auch jeder, der das Wiki nutzt, verstehen, wo er oder sie neue Dokumente anlegen darf und wo nicht. Aus diesem Grund habe ich eine kleine Entscheidungshilfe gebastelt.
„Wo muss ich das dokumentieren? – Ein Cheat Sheet“ weiterlesen
Wir haben in diesem Blog gelernt, dass es es mindestens drei unterschiedliche Arten von Dokumentation gibt. Diese Erkenntnis findet sich optimalerweise auch in der Baumstruktur des Wikis wider. Wie das gehen kann, versuche ich in diesem Beitrag zu skizzieren.
„Welche Baumstruktur eignet sich für die Gliederung eines Wikis“ weiterlesen
Neben der Produkt- und Projektdokumentation gibt es auch die Prozessdokumentation. Sie beschreibt die Arbeitsprozesse wie man zusammenarbeitet. Wer ist das Team? Welche Regeltermine gibt es? Welche Rollen arbeiten wie zusammen? Der Begriff „Prozess“ ist dabei irreführend. Es kommt immer wieder zu dem Missverständnis, dass es sich hierbei um die Dokumentation von fachliche Geschäftsprozessen handeln könnte. Ich bin daher zu der Erkenntnis gekommen, die Prozessdokumentation im Arbeitsalltag als „Organisatorisches“ zu bezeichnen.
Bevor ich in weiteren Blog-Artikeln über Dokumentation im agilen Umfeld schreibe, möchte ich mir zunächst einmal die Grundlagen zur Softwaredokumentation ansehen. Liest man den entsprechenden Wikipedia-Artikel soll eine Dokumentation zeigen, wie die Software funktioniert. Wie geht sie mit Daten um, was ist im Betrieb zu beachten und auf welcher technischen Grundlage wurde entwickelt? Das bedeutet, es kann gar nicht die eine richtige Dokumentation geben.
„Softwaredokumentation – Ein vielschichtiger Begriff“ weiterlesen
Agile Dokumentation 