OneNote als Leitsystem für das Projekt-Management

Entspannt Projekte managen mit OneNote

Von Haus aus ist Microsoft OneNote ja eigentlich „nur“ eine Notizbuch-Software. Allerdings mit dem Potenzial zu sehr viel mehr. Wie wir hier im doctima-Blog schon mehrfach berichtet haben, lässt sich OneNote zu einer intelligenten Projektmanagement-Plattform ausbauen. In der doctima-Redaktion arbeiten wir als Team schon einige Jahre auf dieser Basis. In diesem Post möchte ich noch einmal zusammenfassen, was man tun muss, um dieses Mehr zu erreichen – und was für uns noch heute den Reiz dieser Lösung ausmacht.

Antwort auf zwei zentrale Fragen

Die Grundlage dafür, dass es mit OneNote als Projektmanagement-Plattform klappen kann, liegt in zwei einfachen Fragen. Fragen, die im Grunde für jede Systemeinführung gelten. Was möchte ich mit einer Lösung erreichen? Und wer soll damit arbeiten? Die Frage also nach der Funktion und den Zielgruppen.

Unser Glück war, dass wir diese Fragen bei unserem Start mit OneNote recht gut beantworten konnten. Wir brauchten eine Plattform, die uns bei der inhaltlichen Steuerung der täglichen Projektarbeit unterstützt. Und zwar für ein Team aus bis zu zehn Beteiligten, die allesamt professionell in der Technischen Redaktion unterwegs sind.

Damit war eine klare Grenze gesetzt zu Systemen, die vor allem planerische Aufgaben fokussieren oder auf Verwaltung und Controlling von Budgets spezialisiert sind wie beispielsweise Microsoft Project oder auf Projektmanagement spezialisierte Ticketsysteme wie redmine. Wir haben solche Systeme durchaus im Einsatz, aber als „Hilfssysteme“ und nicht als „Leitsystem“.

OneNote hat sich nach einigen Tests schnell als ein solches „Leitsystem“ angeboten, das unsere naturgemäß stark redaktionell und content-orientierten Bedürfnisse wirksam unterstützt.

Aufgeräumte Informationsstrukturen

A und O eines funktionierenden Datenbestandes sind passgenaue Informationsstrukturen. Strukturen, die über eine längere Zeit halten und in denen sich auch Neueinsteiger – nach einem initialen Briefing – sicher bewegen und zurechtfinden. Im Falle von OneNote betrifft das Thema Informationsstrukturen vor allem die folgenden drei Bereiche:

Die Grobaufteilung der Daten. Liegt alles, was über OneNote organisiert werden soll, in einem einzigen Notizbuch? Oder braucht es mehrere? – Wir als Team haben insgesamt sieben Notizbücher im Einsatz, von denen jedes eine definierte Klasse an gemanagten Daten und Informationen enthält.

Kurz ein Blick in drei dieser Notizbücher – anonymisiert, versteht sich: Herzstück unserer Architektur ist das Notizbuch mit den laufenden Projekten. Quasi als Fundament darunter managt ein weiteres Notizbuch projektübergreifende Informationen und Wissensbestände zu einzelnen Kunden (z. B. den Redaktionsleitfaden, CI-Ressourcen wie das Kundenlogo, spezielle kundenspezifische Arbeitsprozesse, die für jedes Einzelprojekt gelten). Und noch eine Ebene „grundsätzlicher“ angesiedelt ist eine Knowledge-Base in Form eines Notizbuchs, in der wir Fachwissen, das für uns als Team wichtig ist, strukturiert ablegen.

Wie der Screenshot zeigt: Für jedes Notizbuch verwenden wir eine jeweils eigene Form der Informationsstrukturierung. Das Notizbuch für Projekte ist (logischerweise) nach Projekten geordnet, die Knowledge-Base dagegen nach Stichworten.

Als dritte Ebene der Strukturierung arbeiten wir in jedem Notizbuch mit Templates, also vordefinierten Seitentypen. Hier ein Blick auf die Startseite eines Projekts. Wie Sie sehen: Die Aufbereitung der Daten ist strikt standardisiert, was – in diesem Fall zu dem gewünschten – Ergebnis führt, dass jedes Projekt aus Perspektive des standardisierten Informations-Managements unabhängig von seinem Inhalt erst einmal „gleich“ aussieht:

Strikt standardisiert – trotzdem einfach und flexibel

Stringente Standardisierung und Flexibilität müssen sich nicht ausschließen. Das ist etwas, das wir als Team an unserer Lösung mit OneNote sehr schätzen. Dabei kommt uns zugute, dass OneNote im Gegensatz zum Beispiel zu web-basierten Systemen wie Wiki-Plattformen oder Microsoft SharePoint wirklich „wiki“ (also schnell) zu bedienen ist. Es gibt keine Unterscheidung zwischen Frontend (User-Perspektive) und Backend (Verwaltungsperspektive). Brauche ich eine neue Seite, ist sie mit wirklich nur einem einzigen Mausklick angelegt. Natürlich – das System stellt nicht automatisch sicher, dass die Standards (siehe oben) eingehalten werden. Dafür ist der (und nur der) verantwortlich, der vor dem Rechner sitzt. Weil wir ein überschaubares und gut eingespieltes Team sind, ist das für uns kein Problem. In größeren Prozessen kann diese Offenheit von OneNote durchaus zum Fallstrick werden.

Was ich zum Stichwort „Einfachheit“ noch dringend empfehle: Eine Team-spezifische Registerkarte im Menüband von OneNote, die alle Formate, Funktionen und Makros an einer Stelle sammelt. So braucht niemand zu raten, was erlaubt ist und was nicht. Und es geht auch keine Zeit dafür verloren, irgendwo im Menüband von OneNote versteckte Einzelfunktionen zu suchen.

Fazit – Wir bleiben dabei

Ein Leitsystem für’s Projektmanagement mit einer Notizbuch-Software? Ja, das funktioniert. Und auch noch nach Jahren. Wir als Team sehen noch keinen Bedarf, uns grundlegend umzuorientieren. Natürlich hat OneNote deutliche Grenzen, gerade in den Bereichen Automation, Integration und Datenaggregation. Wir arbeiten deswegen wie gesagt mit einem Set an flankierenden Assistenz-Systemen und fahren mit dieser Aufstellung sehr gut.

Ich selbst bin über die Jahre zugegeben zu einem OneNote-Fan geworden – ich organisiere auch privat einiges über OneNote. Und gleich nachher werde ich OneNote wieder beruflich in einem Szenario „at its best“ nutzen. Es geht zu einem Kundenworkshop. Meine Fragen habe ich in OneNote dabei und dank des Caching-Mechanismus die gesamte Projekthistorie mitsamt meiner gewohnten Arbeitsumgebung, ganz so, als würde ich von meinem Schreibtisch im Büro aus arbeiten. Und wenn ich mit den Workshop-Ergebnissen zurückkomme, dauert es nur ein paar Sekunden, bis mein ganzes Team darauf Zugriff hat. Geht’s schneller?

Stoff reduzieren

Ist weniger mehr? – Lehrstoff sinnvoll reduzieren

Titelseite: Ritter-Mamczak "Stoff reduzieren"

Titelseite: Ritter-Mamczak „Stoff reduzieren“

Vor mir liegt nun also ein Arbeitsbuch für die Lehrpraxis an Hochschulen. „Stoff reduzieren“ von Bettina Ritter-Mamczek war der Auftakt zur Reihe „Kompetent lehren“ des UTB-und Budrich-Verlages, in der mittlerweile 8 Bücher erschienen sind. Im Mittelpunkt steht – ganz dem Zeitgeist entsprechend – der Lernende. Wie kann ich Wissen so aufbereiten, dass der Lernende den größtmöglichen Nutzen daraus zieht?
Die Autorin ist selbst seit 19 Jahren als Dozentin und Moderatorin tätig. Sie liefert einen Überblick über Lehrkonzepte und gibt zahlreiche Tipps zur Planung von Lehrveranstaltungen.  Dabei geht es nicht nur um Stoffreduzierung sondern auch um durchdachte Lehrorganisation. Das Buch startet mit einer notwendigen Begriffserklärung als Schnelleinstieg und versammelt dann Konzepte zur Veranstaltungsplanung, insbesondere sog. Fachlandkarten. Zur Veranschaulichung fließen immer wieder Beispiele aus der Praxis ein. Aufgelockert wird das Ganze mit Handzeichnungen.

Hält sich das Buch an seine eigenen Regeln?

Stellenweise fällt es schwierig, sich einen endgültigen Masterplan herauszufiltern. Die Autorin nennt so viele Konzepte und teils sich überschneidende Fragelisten zur Planung, dass ich mich frage, wo ich am besten anfangen soll. Hier liegt es dann doch am Leser selbst, sich daraus einen geeigneten Plan zurechtzubasteln. Aber genau das muss nicht immer ein Nachteil sein. Die Autorin beschränkt sich nämlich nicht nur auf klassische Lehrmethoden, sondern bedient sich auch beim Projektmanagement (s. SMART-Konzept). Die Stärke des Buchs liegt dabei klar in den praxisrelevanten Beispielen und Übungen. Der Leser wird dazu angehalten, die eigene Arbeit im Hinblick auf das Beschriebene zu überdenken oder in Übungen zu erproben. Dadurch stellt sich schnell eine gewisse Routine in der Aufbereitung von Lehrinhalten ein.

Und was nützt das im Unternehmen?

Schön und gut, jetzt habe ich gelernt, wie ich Studenten und Schülern sinnvoll Wissen vermittle. Aber kann ich dieses Wissen auch in anderen Bereichen anwenden? Ein Blick über den Tellerrand lohnt sich. Die vorgestellten Konzepte lassen sich ganz klar auf die Arbeit im Unternehmen und den Redaktionsalltag übertragen. Immer wieder muss ich mich beim Schreiben eines Artikels fragen: Wer sind meine Leser, was meine Ziele, und was ist das zentrale Thema? Das letzte Kapitel widmet sich dieser Problematik und liefert Vorschläge für auftauchende Fragen. Außerdem sind Workshops und Seminare auch bei uns im Unternehmen immer ein Thema. Dafür kann man sich hier bedenkenlos bedienen.

Ein Nachschlagewerk für Wissensvermittlung

Der Tatsache geschuldet, dass das Buch in einer Reihe erschienen ist, werden einige Aspekte nicht behandelt. Es geht nicht darauf ein, wie man Inhalte veranstaltungsübergreifend vorbereitet, was bei heterogenen Gruppen zu beachten ist oder  welcher Medieneinsatz sinnvoll ist. Hier liegen dann auch die Grenzen für mich als Redakteurin im Unternehmen oder Leiterin von Workshops, wo eine homogene Zielgruppe doch eher die Ausnahme ist. Nichtsdestotrotz liefert das Buch einen hervorragenden Einstieg in das Thema. Es richtet sich an Einsteiger und Geübte gleichermaßen, wobei letztere dabei vor allem zur Reflexion ihrer bisherigen Lehrgestaltung angeregt werden. Sollte ich mal vergessen haben, worauf es ankommt, kann ich mich mit diesem Buch immer wieder daran erinnern.

Literatur:  Bettina Ritter-Mamczek [2016; 2. Aufl.]: Stoff reduzieren. Methoden für die Lehrpraxis. Verlag Barbara Budrich, Opladen und Toronto. ISBN 978-3-8252-4462-0
Hinweis: Das hier besprochene Buch wurde uns vom Verlag kostenfrei als elektronisches Rezensionsexemplar zur Verfügung gestellt. Der Verlag hat keinerlei Einfluss auf den Inhalt dieser Besprechung genommen.

Zeit für den Nachwuchs

Das Basler Münster mit Pfalz und Rheinbrücke von Taxiarchos228Eigenes Werk, FAL, Link

Ergänzung (19.05.2017): Wir wurden von einigen Teilnehmern gebeten, mehr Zeit für die Einreichung zu ermöglichen. Deshalb haben wir uns entschlossen, die Frist bis einschließlich 31.05.2017 zu verlängern.

Jedes zweite Jahr ist es wieder Zeit für unseren Nachwuchspreis für berufliche Kommunikation. doctima verleiht mittlerweile zum zweiten Mal gemeinsam mit der Gesellschaft für angewandte Linguistik den Nachwuchspreis für berufliche Kommunikation. In diesem Jahr geht es zur nach Basel. Auf der GAL-Sektionentagung erhalten die Preisträgerin bzw. der Preisträger im großen Rahmen die angemessene Würdigung ihrer Arbeit.

Was musst du tun, um teilzunehmen? Ganz einfach: Bis zum 15.05. ein Abstract deiner wissenschaftlichen Abschlussarbeit einreichen, Lebenslauf dazu, an geschaeftsstelle@gal-ev.de schicken – fertig! Eine Jury aus fünf Wissenschaftlern prüft die Einreichungen und entscheidet dann, wer gewonnen hat. Die komplette Ausschreibung gibt es hier.

Zu gewinnen gibt es natürlich auch etwas: Der Preis ist mit 500 € dotiert und der Gewinner bzw. die Gewinnerin erhält die Gelegenheit, die Siegerarbeit einem breiten Fachpublikum im Rahmen der Eröffnungsveranstaltung der GAL Sektionentagung in Basel vorzustellen. Wer möchte, darf seine Arbeit auch hier im Blog präsentieren. Die Siegerarbeit aus 2015 beschäftigt sich mit der Kommunikation bei Feuerwehreinsätzen; Jan Gerwinski hat sie in einem Post für uns zusammengefasst.

Also ran an die Tastatur und nichts wie losgelegt mit der Einreichung zum doctima-Preis für berufliche Kommunikation.

Wie technische Redakteure den Wandel in der technischen Kommunikation aktiv mitgestalten können

Wenn der Zeitdruck steigt, bleibt die Qualität leicht auf der Strecke.

Wenn der Zeitdruck steigt, bleibt die Qualität leicht auf der Strecke.

In unserer Reihe zu Trends in der Technischen Redaktion haben wir heute Ina Franke zu Gast. Sie ist Senior Marketing Manager bei der Acrolinx GmbH. Acrolinx hilft Unternehmen überzeugenden Content zu erstellen: markenkonform, wirkungsvoll und skalierbar. Ausgestattet mit einer fortschrittlichen Sprachtechnologie, „liest“ Acrolinx Content und leitet Autoren an, ihn zu verbessern. Mehr Informationen dazu finden sich auf acrolinx.de.

Der Wert der technischen Kommunikation wird auf Unternehmensebene häufig unterschätzt. Manager betrachten die technische Kommunikation oft als notwendige Kostenstelle und übersehen dabei ihre enorme Bedeutung für die Gewinnung und Bindung von Kunden. Gleichzeitig tun technische Redakteure noch immer wenig, um diese Vorstellung zu korrigieren. Besonders, wenn sie ihren Aufgabenbereich darauf reduzieren, Verbrauchern Fragen zu Produkten und Fehlerbehebungen zu beantworten.

Mit der weiterhin steigenden Bedeutung von Content beobachten wir 6 wichtige Veränderungen im Bereich der technischen Kommunikation, die die Rolle von technischen Redakteuren neu definieren:

  1. Die Erstellung von technischem Content wird vorverlagert. Immer häufiger sind es Ingenieure und Mitarbeiter in der Produktentwicklung und im technischen Support, die Inhalte erstellen. Dadurch wird es schwieriger, für Konsistenz zu sorgen – sowohl innerhalb der technischen Redaktion als auch unternehmensweit. Verschärft wird das Problem dadurch, dass Content oft ohne eine abteilungsübergreifende Abstimmung veröffentlicht wird. Dies kann zu inkorrekten Informationen und unzufriedenen Kunden führen.
  2. Knappe Budgets oder eine fehlende Wertschätzung der technischen Kommunikation können zur Folge haben, dass das Erstellen von technischem Content ausgelagert wird. Auch dies führt dazu, dass Inhalte von zentralen technischen Ressourcen wie Produktentwicklungsteams oder der gesamten Content-Strategie abgekoppelt werden.
  3. Content wird zunehmend von Nicht-Muttersprachlern erstellt. Zu den Folgen dieser Entwicklung zählen fehleranfälliger und inkonsistenter Content, schwer verständliche und kostenaufwändige Übersetzungen und ein mangelnder redaktioneller Überblick. Das Fehlen effektiver Qualitätskontrollen erschwert es außerdem, Fehler zu beheben – oft bleiben diese unkorrigiert.
  4. Vor allem englischer Content wird zunehmend von Nicht-Muttersprachlern gelesen. Vor diesem Hintergrund müssen technische Informationen leicht verständlich sein und interkulturellen Anforderungen genügen. Eine computerunterstützte Übersetzung kann für die Lokalisierung von technischem Content hilfreich sein, erfordert aber eine zusätzliche Qualitätskontrolle.
  5. Engere Zeitpläne machen schnellere Turnarounds erforderlich. Dabei ist es wichtig, dass technische Redakteure frühzeitig integriert werden. Das ist leider nicht immer der Fall. Der Fokus auf Kosten und Schnelligkeit führt häufig sogar dazu, dass technische Inhalte erst auf Nachfrage von Kunden geschrieben werden. So hinkt technischer Content den Entwicklungen oft hinterher.
  6. Technische Redakteure teilen ihr Wissen in sozialen Medien, die von immer mehr Kunden als Ergänzung oder sogar als Ersatz für die eigentliche Dokumentation wahrgenommen werden. Statt Content vor der Auslieferung eines Produkts zu erstellen, reagieren technische Redakteure in Echtzeit auf Fragen von Kunden. Hierbei ist es wichtig, eine gute Balance zu finden. Ansonsten besteht die Gefahr, dass Unternehmen Social Media als zusätzliche Rechtfertigung dafür sehen, technischen Content weiter zu kürzen.

Als technischer Redakteur sollten Sie die genannten Entwicklungen zum Anlass nehmen, sich geschickt neu zu positionieren. Dazu sollten Sie zunächst Ihre Selbstwahrnehmung überprüfen und sich den Wert ihrer Arbeit bewusstmachen.

Die technische Kommunikation kann einen wertvollen Beitrag dazu leisten, die Umsätze Ihres Unternehmens zu steigern. Überlegen Sie, wie Sie strategische Prioritäten Ihres Unternehmens unterstützen und dies nachvollziehbar demonstrieren können. Zeigen Sie, dass die Nachfrage nach Ihrem Content wächst. Dabei können Sie sich auch auf die Marketing-Strategie Ihres Unternehmens und die Wünsche von Kunden beziehen.

Ihre Arbeit spielt eine wichtige Rolle, das Leistungsversprechen Ihres Unternehmens umzusetzen. Um das Potential Ihrer Rolle voll auszuschöpfen, müssen Sie den Wert Ihrer Arbeit jedoch überzeugend auf den Punkt bringen.

Gehörige Horizonterweiterung – Wie Bürger- und Kundenkommunikation gelingen kann

Die Qualität eines Textes kann nicht losgelöst von der kommunikativen Funktion bestimmt werden. Während ich in diesen Wochen ein kommunales Serviceunternehmen dabei unterstütze, seine Kundenanschreiben hinsichtlich Verständlichkeit, Prägnanz und Leserbezug einer Generalüberholung zu unterziehen, liegt das „Handbuch Bürgerkommunikation“ griffbereit neben mir auf dem Schreibtisch. Aus ihm stammt der eingangs zitierte Satz. Ihn kann ich aus meiner Erfahrung in der Beratung von Kommunen, Banken, Krankenkassen und Versicherungen nur unterschreiben. Und er spielt auch in meinem aktuellen Projekt eine Rolle.

Wesentlich mehr als ein Ratgeber

Das Handbuch Bürgerkommunikation: Es fasst die Erfahrungen und fachlichen Grundlagen eines großangelegten Projekts der Stadt Arnsberg zusammen, die schon vor über zehn Jahren zusammen mit einem linguistisch kompetenten Beratungsteam daran ging, ihren Sprach- und Schreibstil systematisch auf größtmögliche Bürgernähe hin auszurichten. Und das mit Erfolg. Das Handbuch Bürgerkommunikation ist damit ein gutes Beispiel dafür, wie sprachwissenschaftlich fundierte Kommunikationskonzepte einen entscheidenden Unterschied machen.

Dieses Attribut „wissenschaftlich“ ist es auch, das für mich den großen Mehrwert dieses Buches gegenüber anderer Literatur im Bereich Textoptimierung ausmacht – vor allem gegenüber der klassischen Ratgeberliteratur. Es geht nicht um ein bisschen mehr „Pfiff“ oder einen „lockeren Stil“ – sondern alles, was gefordert und geraten wird (und das passiert durchaus mit ganz konkreten Beispielen und Empfehlungen), steht auf soliden fachlichen Füßen. Und so bilden die Basis dieses Buches und seiner insgesamt neun Module (Kapitel) auch nicht die erwartbaren Stilblüten und Schenkelklopfer aus dem Fundus deutscher Behördenpublikationen, sondern Themen wie „Modelle der Textverständlichkeit“ (Modul 1), „Soziale Klugheit“ (Modul 3) oder „Instrumente der Identitätskommunikation“ (Modul 7).

Sparringspartner für harte Nüsse

Das zeigt schon: Ganz einfache Kost ist dieses Buch nicht. Es geht um Sprachwissenschaftliches, Kommunikationswissenschaftliches, Soziologisches und auch (Staats-)Philosophisches. Und es gibt Nebentöne, die in der mitunter stark auf Effizienz getrimmten Debatte um die Optimierung von Kommunikation eher ungewöhnlich sind, z. B. wenn es um die gesellschaftliche Verantwortung von Kommunizierenden geht.

Mein Fazit: Wer mehr als bloß ein paar Tipps zur Bürger- und Kundenkommunikation sucht, wer als Profi einen weiten Horizont benötigt und tiefer verstehen möchte, weil er nur so zu wirklich passenden Lösungen findet: Dem kann ich dieses Buch nur empfehlen.

Ich werde es auf jeden Fall noch einmal intensiv durcharbeiten. Und es dabei auch befragen zu Innovationsthemen, die in unseren Projekten zunehmend wichtig werden. Zum Beispiel wie sich das Konzept der Leichten Sprache noch wirkungsvoller in die Bürger- und Kundenkommunikation integrieren lässt.

Literatur: Ebert, Helmut/Fisiak, Iryna [2016]: Handbuch Bürgerkommunikation: Moderne Schreib- und Kommunikationskultur in der Dienstleistungsverwaltung. LIT Verlag, Berlin, 331 Seiten. 978-3825887575

Hinweis: Das hier besprochene Buch wurde uns vom Verlag kostenfrei als Rezensionsexemplar zur Verfügung gestellt. Der Verlag hat keinerlei Einfluss auf den Inhalt dieser Besprechung genommen.

API-Dokumentation – Was brauchen und wollen Entwickler?

Code ist undokumentiert schwer zugänglich
(c) Markus Vogelbacher via pixelio.de

Heute freuen wir uns, wieder einmal eine Gastautorin im doctima-Blog zu begrüßen. Stephanie Steinhardt ist Dipl. Technik-Redakteur (FH) und wissenschaftliche Mitarbeiterin an der Hochschule Merseburg. Als freiberufliche Technik-Redakteurin betreut sie außerdem verschiedene Kunden z. B. aus dem Automobilbereich. In ihrem Post zeigt Sie uns erste Ergebnisse aus einer gemeinsamen Forschungsarbeit mit Prof. Dr. Michael Meng und Andreas Schubert (MA) an der HS Merseburg. Doctima ist an diesem Projekt als Vernetzungspartner beteiligt.

Die Sicht von Entwicklern auf API- Dokumentation ist oftmals sehr verschieden. Während die einen davon überzeugt sind, dass guter Code keiner Dokumentation bedarf, schreiben die anderen selbst gern Dokumentation und konsultieren sie auch häufig. Die Meinungen darüber, wie sie denn aussehen soll, die perfekte API-Dokumentation, gehen ebenfalls auseinander. Es existieren unterschiedliche Ansätze zu Aussehen, Darreichung und Inhalt einer solchen.

An der Hochschule Merseburg widmet sich seit zwei Jahren ein kleines Team von Technik-Redakteuren in einem Forschungsprojekt der Optimierung von API-Dokumentation. Die Fragen nach Struktur und Inhalt der perfekten API-Dokumentation sowie nach dem Leseverhalten der Entwickler stehen dabei im Mittelpunkt der Untersuchungen. Auf Basis von 23 durchgeführten Interviews, der Erhebung von Daten aus rund 100 Fragebögen und einer Beobachtungsreihe, bei der genau verfolgt wurde, wie Entwickler Programmieraufgaben lösen, sowie unter Berücksichtigung der bereits existierenden Studien im Umfeld von Entwicklerdokumentation können wir Empfehlungen geben, die API-Dokumentationen deutlich besser und effizienter nutzbar machen.

Nicht jeder Entwickler ist wie der andere.

Entwickler unterscheiden sich nicht nur in ihrer Einstellung zur Dokumentation, in den Jahren ihrer Programmiererfahrung oder bezüglich der Systemwelt, in welcher sie zu Hause sind. Sie unterscheiden sich vor allem in ihrer Arbeitsweise. So konnten wir in unseren erhobenen Daten zwei verschiedene Ansätze identifizieren, welche vor allem bei der Einarbeitung in eine neue API deutlich hervortreten. So gibt es Entwickler, die einen eher codegetriebenen Ansatz verfolgen und nach eigener Aussage gern direkt mit einem Code-Beispiel einsteigen. Sie erarbeiten sich den Umfang einer API eher intuitiv von unten nach oben. Es gibt aber auch Entwickler, die konzeptorientiert arbeiten und sich vor der Nutzung einer neuen API zunächst einen Überblick verschaffen. Entwickler, die der Meinung sind, dass es nützlich ist, das Konzept der API in Gänze zu verstehen, auch wenn nur ein Teil der API tatsächlich zur Problemlösung genutzt wird.

Abb.: 1 – Absolute Zeitwerte: Recherchezeit (farbig) vs. Bearbeitungszeit (grau) der Probanden 01-11

Besonders deutlich traten diese Verhaltensmuster in der von uns durchgeführten Beobachtungsreihe hervor. So haben 6 der 11 beobachteten Probanden im Konzeptbereich der API-Dokumentation unserer Test-API gelesen, wohingegen die anderen 5 kaum einen Blick hinein warfen und vorrangig auf Beispielcode fixiert waren.

Lesen ist nicht gleich lesen.

Trotz der gegensätzlichen Sichtweisen der Entwickler auf API-Dokumentation hat die Beobachtung gezeigt, dass im Beobachtungszeitraum von jeweils einer Stunde alle Probanden nahezu die Hälfte der Zeit mit der Recherche in der API-Dokumentation zubrachten, während die andere Hälfte für die tatsächliche Programmierung zur Lösung der Aufgaben verwendet wurde.

Wie die Analyse der entstandenen Eyetracking-Aufnahmen zeigte, scannten und überflogen die Entwickler die einzelnen Inhalte mehr, als dass sie tatsächlich Zeile für Zeile lasen. Dabei fokussierten Sie vorrangig auf die visuell hervorgehobenen Elemente, wie Hyperlinks, die Navigation und Beispielcode. Der erklärende Fließtext wurde meist nur dann gelesen, wenn aus dem Beispielcode allein keine Lösung abzuleiten war.

Das Leseverhalten schien darüber hinaus nicht nur beeinflusst von der individuellen Arbeitsweise, sondern war auch geprägt von der Einschätzung zum Schwierigkeitsgrad der gestellten Aufgabe. Bei Aufgaben, die schwieriger zu lösen schienen, waren die Probanden eher geneigt zu lesen, als bei Aufgaben, die einfacher wirkten.

Wer die Prozesse kennt, ist klar im Vorteil.

Bereits in den Interviews und in existierenden Studien kam zum Vorschein, dass mitunter alleinige Programmiererfahrung kein Garant ist für die schnelle Einarbeitung in eine neue API. Vielmehr entscheidend ist das vorhandene Domainwissen. Wer mit den zugrunde liegenden Prozessen vertraut ist, welche die API abbildet und dazu das Fachvokabular kennt, ist deutlich schneller bei der Einarbeitung und Lösung von Programmieraufgaben. Das zeigte auch unsere Beobachtungsreihe sehr eindrücklich (vgl. Abbildung 1 – Probanden 03, 04, 05,06 und 10 besaßen Domainwissen).

Demnach kommt der Vermittlung von Domainwissen in einer API-Dokumentation eine wichtige Rolle zu. Die Platzierung dieser Informationen ist mit Hinblick auf Leseverhalten und Arbeitsweise der Entwickler elementar.

Abb.: 2 – Beispiellayout für Codekommentare im Beispielcode (adaptierter Inhalt, basierend auf https://developers.shipcloud.io/reference/)

Der beste Ort für wichtige Informationen in einer API-Dokumentation ist einer, den alle Entwickler tatsächlich anschauen. Auf Basis der Interviews, den Fragebögen und der Beobachtung können nur Codebeispiele dieser Anforderung genügen. Sie werden von allen Entwicklern angesehen und als Basis der eigenen Programmierung verwendet. „Verkleidet“ man wichtige Informationen als Codekommentar und setzt diese deutlich vom restlichen Codebeispiel ab, kann man sicher sein, dass sie gesehen und, wenn kurz, auch gelesen werden. Auf ausführlichere Beschreibungen sollte zugunsten der eher konzeptorientierten Entwickler aber dennoch nicht verzichtet werden.

Dieser konkrete Optimierungsvorschlag und die zuvor genannten Erkenntnisse sind natürlich nur ein kleiner Teil der bisher gewonnenen Forschungsergebnisse. Unsere Untersuchungen dauern im Moment noch an. Daher sind wir auch sehr interessiert an Unternehmen, die bereit sind, sich an ähnlichen Studien zu beteiligen und damit die Zahl der möglichen Probanden vergrößern.

Kontakt: stephanie.steinhardt@hs-merseburg.de

Verständlichkeit – wissenschaftlich und praktisch

„verständlich kommunizieren“ an der Hochschule Luzern

Verständlichkeit ist bei uns ja eines der Kernthemen. Dass sich dazu auf wissenschaftlicher Seite leider weniger tut, als wir uns wünschen, habe ich im doctima Blog schon beklagt. Umso mehr hat mich gefreut, dass mich Sascha Demarmels vor kurzem auf ihr Blog an der Hochschule Luzern aufmerksam gemacht hat. Unter dem Titel verständlich kommunizieren bloggt ihre Arbeitsgruppe zu verschiedenen Themen rund um die Verständlichkeit – aus wissenschaftlicher Sicht wie auch in der praktischen Anwendung.

Leider sind die meisten Posts schon ein wenig älter. Das nimmt den Beiträgen zwar nicht ihren Wert (Verständlichkeit ist ja kein Hype-Thema, das man tagesaktuell verfolgen muss). Aber es wäre wirklich schade, wenn das bedeutet, dass das Blog nun still und leise einschläft. Deshalb meine ich diesen Post nicht nur als Leseempfehlung, sondern auch als Ermutigung an die Bloggenden von der HS Luzern: „Wir wollen gerne mehr davon sehen!“

 

Weihnachten, gecheckt! Unser Gutzi 2016

Geht es Ihnen auch so? Ist die ach so besinnliche Adventszeit mit beruflichen und privaten Terminen bis zum Platzen gefüllt? Und wünschen Sie sich auch, dass nächstes Jahr alles besser wird?

Dann haben wir dieses Jahr genau das Richtige für Sie. Denn immer, wenn wir in Stress kommen, dann sorgen wir mit Checklisten für Überblick. Johannes Dreikorn hat das auf der tekom Herbsttagung dieses Jahr anschaulich vorgestellt. Klar, dass wir mit Checklisten auch für mehr Freiraum im nächsten Jahr sorgen wollen.

Und deshalb haben wir Ihnen vier Checklisten gestaltet, damit beruflich und privat alles geschmeidig läuft:

  • eine Checkliste für das Berufliche, mit der Sie die Content-Qualität Ihrer Dokumentation schnell abprüfen können,
  • eine Checkliste für das Team, um die Kaffeemaschine fit zu halten,
  • eine Checkliste für das ganze Jahr, mit der Sie Ihre Einkäufe leichter organisieren und
  • eine Checkliste für Weihnachten 2017, damit die „staade Zeit“ dieses Mal auch wirklich besinnlich wird.

Mit unserem Weihnachts-Gutzi wünschen wir allen unseren Lesern und Leserinnen besinnliche Feiertage und einen guten Start für 2017.

Information 4.0 – Schritte auf dem Weg zur Intelligenten Information

Industrielle Steuerung?Die Digitalisierung der Arbeitswelt ist derzeit eines der meist diskutierten Themen. Auch unserer Branche, der Technischen Dokumentation, stehen tief greifende Veränderungen bevor.
Seit Anfang 2016 bin ich Mitglied der tekom-AG „Information 4.0“ und gestalte dadurch diese Veränderungen mit. In der AG arbeiten wir iiRDS aus, einen Standard zur Bereitstellung von intelligenter Information in digitalisierten, vernetzten Umgebungen. Mit diesem Beitrag fasse ich einige meiner Gedanken zum Thema Industrie 4.0 und intelligente Information zusammen.

Einige Begriffe

  • Industrie 4.0, digitale Fabrik: Sich selbst steuernde, weitestgehend automatisierte Fertigungsprozesse, die der Mensch nur noch „orchestriert“ und bei Bedarf eingreift.
  • Cyberphysikalisches System: Komponente, die aus einem dinglichen Objekt und aus einer digitalen, vernetzten Repräsentation besteht.
  • RAMI 4.0: dreidimensionales Referenzarchitekturmodell der Plattform Industrie 4.0. Strukturiert das Thema nach Lebenszklus von Entwurf bis Entsorgung, Hierarchie von Einzelkomponente bis zur umgebenden Cloud und nach Integrationslevel von Objekt („Asset“) bis Geschäftsmodell („Business“).
  • Verwaltungsschale: Digitale Repräsentation eines cyberphysikalischen Systems. Enthält beschreibende und identifizierende Eigenschaften, Sensordaten und Zugriffsmöglichkeiten zu digitalen Funktionen.

Technische Dokumentation heute

Für die meisten Akteure im Umfeld Industrie 4.0 findet Technische Dokumentation auf dem sog. „Asset Level“ in der digitalen Fabrik statt. Sie gehen gedanklich vom aktuellen Status Quo (oder eigentlich von dem Stand vor zehn Jahren) aus, und der heißt PDF. Dokumente für Installation, Wartung, Betrieb und ggf. Entsorgung werden als Einheiten betrachtet und als abrufbare Eigenschaften in der Verwaltungsschale eingeplant.

Auf diese Granularität zielt wohl auch die in Arbeit befindliche VDI-Richtlinie 2770 zur digitalen Herstellerinformation ab. Für einige Branchen (gerade ältere Industrieanlagen sind in der Regel auf Papier dokumentiert) ist das auch sicher ein Fortschritt. Aber natürlich geht viel mehr.

Intelligente Information

Technische Dokumentation lässt sich viel präziser modularisieren. In vielen Redaktionen wird das bereits heute betrieben, v. a. als Basis des Variantenmanagements: Die Filterung nach Zielgruppen, Sprachen, Gerätevarianten findet heute bereits statt und zwar beim Publizieren von Dokumentvarianten.

In einer Industrie-4.0-Umgebung lässt sich diese Filterung zum Lesezeitpunkt hin verlagern. Damit werden gezielte Abfragen möglich, die dem Anwender die von ihm benötigte Information passend zu seiner aktuellen Aufgabe bereitstellen.

Dazu werden Metadaten benötigt, die die einzelnen Informationsmodule klassifizieren und identifizieren. Zuordnung zu Hersteller, Gerät, Variante, Komponente und Funktionsgruppe sind ebenso entscheidend wie Sprache, Zielgruppe und Informationstyp. Außerdem erfordert die Integration ein Auslieferungsformat, das sich embedded, mobil und am Schreibtisch sauber anzeigen lässt. Standardisierung ist nötig, damit sich die Dokumentation unterschiedlicher Hersteller zu einer Gesamtinformation integrieren lässt.

Bei der tekom arbeiten wir an einem solchen Standard, dem iiRDS. Die Arbeitsgruppe hat ihre Zwischenergebnisse auf der tekom-Jahrestagung vorgestellt. Der Standard soll Mitte nächsten Jahres verfügbar sein.

Wo am Ende die Informationen bereitgestellt werden, ob direkt beim Komponentenhersteller, beim Anlagenbauer, vor Ort beim Betreiber der digitalen Fabrik oder direkt auf der Komponente, ist dabei offen. Ebenso ist offen, ob die Information auf einem eigenen Content Delivery Server, einem integrierten Webservice (der zum Beispiel über den doctima ContentConnect mit Inhalten versorgt wird) oder als Informationsbausteine in einem Asset Management System wie SAP AIN zu liegen kommen. Das abstrakte Konzept der Verwaltungsschale erlaubt hier viele Wege zu gehen.

Die Idee, dass alle (bleiben wir realistisch: möglichst viele) Ersteller von Technischer Information ein gemeinsames Format bereitstellen, um dem Anwender einen integrierten Wissensschatz zu einem aus vielen Komponenten bestehenden System bereitzustellen, erscheint mir auch ohne den direkten Bezug zu Industrie 4.0 ein absolut erstrebenswertes Ziel zu sein – weil es u. a. zu Verbesserungen für das leidige Thema Zulieferdokumentation bringen kann. In der Denkweise des RAMI 4.0 lässt sich die Dokumentation von der untersten Ebene mit PDF-Dokumenten als „Assets“ auf die vierte Ebene, das Information Layer, mit Content-Delivery-Diensten als funktionaler Teil der übergreifenden Verwaltungsschale aufwerten.

Ich bin sehr gespannt auf die kommenden Entwicklungen und wie sich das iiRDS-Format in der Praxis bewähren wird – und auf Ihre Meinung. Wie sind Ihre Erwartungen bezüglich der Digitalisierung der Arbeitswelt? Diskutieren Sie mit uns in den Kommentaren!

Lasten- und Pflichtenhefte – der Erfolg entscheidet sich am Dokumentkonzept

Vorgefertigte Lastenhefte wollen viele. Aber wären die sinnvoll?

Vorgefertigte Lastenhefte wollen viele. Aber wären die sinnvoll?

Seit gut zehn Jahren bin ich in Unternehmen unterwegs, um mit Entwicklungsabteilungen einen für die Ingenieure oft lästigen Dokumenttyp auf Vordermann zu bringen: Lasten- und Pflichtenhefte. Egal wohin ich komme, hegen meine Kunden eine ganz bestimmte Hoffnung. Eine Hoffnung, die sich in zwei Fragen ausdrückt:

Frage 1: Gibt es Normen, die man unbedingt beachten muss, um ein wirklich sauberes (und damit vollständiges und möglichst rechtssicheres) Lastenheft oder Pflichtenheft zu erstellen?

Und Frage 2: Gibt es nicht allgemeingültige Dokumentvorlagen mit allen benötigten Inhalten – am besten downloadbar aus dem Web? Und dann ist alles gut?

Unerfüllbare Hoffnungen

Diese Hoffnung muss ich regelmäßig enttäuschen. Leider – könnte man erst einmal meinen.

Natürlich gibt es Normen, die Lasten- und Pflichtenhefte thematisieren, zum Beispiel die DIN 69901. Aber diese Normen helfen bei den Fragen, die die Unternehmen umtreiben, nicht wirklich weiter. Normen kann man vor allem Definitionen entnehmen, was ein Lasten- oder Pflichtenheft ist, was als Gliederung eventuell sinnvoll ist und wie man diese Dokumente in Entwicklungsprozessen am besten einsetzt. Gewonnen ist damit nicht viel.

Dasselbe gilt für downloadbare Vorlagen: Sie können einem einen ersten Eindruck geben, was vielleicht wichtig ist. Aber eine Dokumentvorlage und vor allem die darin enthalten Inhaltspunkte entspringen immer einem bestimmten Kontext und treffen nie passgenau zu. Oder sie sind so allgemein gehalten, dass sie im Grunde nichts aussagen.

Die gute Nachricht – Freiraum für passgenaue Dokumentkonzepte

Mit „Kontext“ ist das relevante Stichwort schon gefallen. Jedes Unternehmen arbeitet (egal ob Auftragnehmer oder Auftraggeber, egal ob Lastenheft oder Pflichtenheft) unter anderen Rahmenbedingungen. Produkte unterscheiden sich technologisch grundlegend, die Vertragspartner sind unterschiedliche, interne Dokumente benötigen andere Inhalte als Dokumente, die über Unternehmensgrenzen ausgetauscht werden. Abhängig davon, wer die Designverantwortung trägt, entwickeln Lasten- und Pflichtenhefte erst ihre eigentliche Gestalt.

Eine Lösung von der Stange – das zeigt mir die Praxis immer wieder ganz deutlich – kann es eigentlich gar nicht geben.

Genau hier aber liegt die große Chance für die Unternehmen. Und das ist die Botschaft, die die Miene meiner Kunden ganz schnell wieder aufhellt. Weil der Kontext hochgradig individuell ist, besteht große Freiheit in der Gestaltung von Lastenheften und Pflichtenheften. Ganz sicher keine Beliebigkeit, aber ein Freiraum, in dem man eine unternehmensspezifisches Dokumentenkonzept entwickeln kann. Ein Konzept, das dann wirklich funktionierende Dokumente ermöglicht.

Was so ein spezifisches Dokumentenkonzept ganz konkret ausmacht, möchte ich hier noch an drei Beispielen zeigen:

Beispiel 1: Es muss nicht immer viel sein

Dieses Konzept ist vor gut zwei Jahren in München entstanden. Ein Unternehmen der Schwerindustrie liefert als Auftragnehmer eine Presseinrichtung für eine große Stahlverarbeitungsanlage. Das spezifizierte Produkt ist für meine Vorstellungen riesengroß, das Pflichtenheft dazu ist aber maximal schlank geworden. Es ist wenige Seiten lang und macht zusammen mit dem Maschinenplan trotzdem eine vollumfängliche Leistungszusage an den Auftraggeber.

Der Kunde hat sehr aufgeatmet: Dass ein Projekt mit Pflichtenheft die Dokumentationsaufwände der Ingenieure, die ja sowieso schon unter hohem Zeitdruck arbeiten, vervielfachen würde – diese Befürchtung hat sich nicht bewahrheitet.

Beispiel 2: Ein Dokument, das skaliert

Genau hinsehen! Auf dem Weg zu einer passgenauen Dokumentkonzeption

Genau hinsehen! Auf dem Weg zu einer passgenauen Dokumentkonzeption

Ein Unternehmen für Fenster- und Fassadentechnologie definiert seinen Entwicklungsprozess für Innovationsprojekte neu. Damit die Entwicklung koordiniert abläuft, soll der Vertrieb als unternehmensinterner Auftraggeber ein Lastenheft schreiben. Das Problem an der bisherigen Praxis: Das Lastenheft des Vertriebs ist der Entwicklung zu unspezifisch, der Vertrieb möchte aber nichts vorgeben und spezifizieren, worüber er noch keine Aussagen machen kann. Eine klassische Patt-Situation.

Als Lösung haben wir ein Lastenheft konzipiert, das mitwachsen kann. In seiner ersten Fassung (das „Lastenheft light“) formuliert der Vertrieb die Produktidee und die zentralen Leistungsmerkmale des neu zu entwickelnden Produkts. Dieser Stand dient der internen Abstimmung. Erst wenn klar ist, ob sich dieses Produktkonzept technologisch und wirtschaftlich umsetzen lässt (und in diesem Bewertungs- und Aushandlungsprozess sitzt die Entwicklung mit am Tisch), wird ein „richtiges“ und umfassendes Lastenheft erstellt, das für die Entwicklungsabteilung die Vorgaben in relevanter Breite und Tiefe niederlegt.

Dass dieses Konzept aufgeht, ist konzeptionell vor allem der Gliederung der neuen Lastenheftvorlage zu verdanken. Sie kann angelehnt an den Fortschritt im Entwicklungsprozess von vorne nach hinten wachsen. Es ist als Lastenheft-Standard eine ganz individuelle Lösung entstanden, die sich durch ein hohes Maß an Flexibilität und Skalierbarkeit auszeichnet.

Beispiel 3: Antworten auf 1500 Anforderungen

Ein letztes Beispiel: Ein Automobilzulieferer bekommt von seinen Auftraggebern in schöner Regelmäßigkeit Lastenhefte vorgelegt, die 300 Seiten und länger sind. Um noch einmal eine Zahl zu nennen: Wir reden von 1200 bis 1500 Anforderungen.

Wie kann nun ein Pflichtenheft bzw. die Leistungszusage in so einem Szenario aussehen? Und zwar ohne dass als Pflichtenheft ein noch längeres Monsterdokument entsteht, das unsinnige Aufwände erzeugt? Denn immerhin sagt die reine Lehre – und auch die Auftraggeber aus dem Automobilsektor fordern es: Ein Pflichtenheft muss Antwort geben auf alle Anforderungen des Auftraggebers.

In diesem Fall entwickeln wir eine Lösung aus zwei Dokumenten:  Die Detailantworten stehen in einer Excel-Liste, die eine maximal kurze Antwort auf wirklich jede Anforderung gibt. Dazu kommt aber – und das war hier das Aha-Erlebnis – ein Rahmendokument, in dem der Auftragnehmer noch einmal losgelöst von dem Detaildokument seine Lösung und seine Leistungsfähigkeit konzentriert darstellt. Das zudem Punkte hervorhebt und anbringt, die ihm aus seiner Rolle heraus wichtig sind – und nicht nur solche, die der Auftraggeber aktiv nachfragt. Und das zu guter Letzt sogar – auch das ein Novum – den Auftraggeber in die Pflicht nimmt.

Seit diesem Jahr gehen alle „Antworten“ dieses Kunden auf diese Weise zurück an seine Auftraggeber.

Buchbar als Praxispaket Lastenhefte/Praxispaket Pflichtenhefte

Die konzeptionelle Anlage eines Lasten- oder Pflichtenheftes halte ich im Rückblick auf bestimmt 60 Beratungs-Einsätze als den wesentlichen Schlüssel zum Erfolg. Und das Schöne ist, dass man die Konzepte so auslegen kann, dass daraus ein wirklicher Standard entsteht – also Vorlagen und Definitionen, die für ganze Klassen von Projekten tragen und nicht nur für einen Einzelfall.

Sollten Ihnen diese Sorte Spezifikationsdokumente auch im Magen liegen: Schauen Sie sich doch einfach einmal unser ‚Praxispaket Lastenhefte/Praxispaket Pflichtenhefte‚ an. Ein bewährtes Verfahren, in dem wir schon ganz viele Unternehmen begleitet haben.