Die Dokumentation, gehört bei uns zu dem Bereich, der nicht direkt mit der Entwicklung verbunden ist.
Ein Teil der Doku wird vorab von den Entwicklern entworfen, aber erhalten letzten Endes den Feinschliff von Anderen. Auch die weitere Pflege und auch die Übersetzungen werden nicht von der Entwicklungsmannschaft durchgeführt.
Eigentlich haben wir nur „everlasting“ Projekte haben, dass heißt unsere Projekte werden immer weiter gepflegt. Das ändert sich oft erst nach so nach 6-10 Jahren wenn sie in eine neues Produkt mit einem kompletten Redesign übergehen.
Das bedeutet auch für die Dokumentation eine immer wiederkehrende Überarbeitung. In der Vergangenheit, haben oft genug Verbesserungen nicht den Weg in die Doku gefunden, weil einfach vergessen wurde eine entsprechende Notiz zu schreiben.
Großes Erstaunen herrschte dann oft, wenn der Vertrieb ein Feature anmahnte, dass die Entwicklung schon längst implementiert hatte.
Mit der Einführung des Team Foundation Server (TFS) und Visual Studio Team Systems 2008 wollte ich auch den Informationsfluss an andere Firmengruppen verbessern, insbesondere zu den Personen, die die Doku schreiben und für die Publikationen der Updates zuständig sind.
Erreicht haben wir das durch zwei ganz einfache Schritte:
- Haben wir Visual Studio Team System Web Access 2008 SP1 Power Tool installiert, das als CTP vorliegt. Dadurch kann jeder einfach und simpel von jedem Rechner auf den TFS und die Workitems zugreifen ohne VS installiert zu haben.
Die entsprechenden User wurden mit „Reader“-Rechten im TFS ausgestattet, sofern sie nicht sowieso schon zum Teil die Rolle eines Testers hatten. - Habe ich das Team Foundation Server Event Subscription Tool installiert.
Die Events die man über die Menüs in VS-2008 einrichten kann sind doch etwas dürftig. - Mit dem Team Foundation Server Event Subscription Tool habe ich dann zwei WorkItemChangedEvents eingerichtet, die bei einem Status „Closed“ (für Tasks) oder „Resolved“ (für Bugs), sofort eine Email mit dem entsprechenden Infos des Workitems an eine Emailverteilergruppe sendet.
Jetzt wird jeder „Close“ eines Tasks, bzw. jedes „Resolved“ eines Bugs sofort weiter gemeldet.
Die Mitarbeiter können sich über die entsprechenden Links, die Informationen aus dem Task oder Bug holen und die Dokumentation, Readme’s, Hilfedateien und Übersetzungen anpassen.
PS: Ja man hätte dies auch noch mit eigenen Projekt-Tasks und spezielen Statis regeln können, aber der Weg, so erschien mir einfach, simpel und praktikabel.
PPS: Im dem Team Foundation Server Event Subscription Tool kann man übrigends noch andere sehr nützliche Benachrichtigungen erzeugen…