Entwickler dazu bringen, ein Wiki zu verwenden [geschlossen]

https://stackoverflow.com/questions/15871

08-06-2019
|

Frage

Ich arbeite an einer komplexen Anwendung, bei der verschiedene Teams mit gewissen Überschneidungen an ihren eigenen Modulen arbeiten.Vor einiger Zeit haben wir, teilweise auf meine Anregung hin, eine Mediawiki-Instanz eingerichtet.Es fällt mir schwer, die Leute dazu zu bringen, es tatsächlich zu nutzen, geschweige denn einen Beitrag zu leisten.

Ich sehe einen großen Nutzen darin, Informationen auszutauschen.Es könnte zumindest die Zeit verkürzen, in der wir das Rad neu erfinden.

Das Wiki ist nicht sehr strukturiert, aber ich bin mir nicht sicher, ob das ein Problem darstellt, solange man nach dem suchen kann, was man braucht.

Irgendwelche Hinweise?

Lösung

Wie ich bereits erwähnt habe Vor, ein Wiki ist sehr unorganisiert.

Wenn dies jedoch das einzige Argument Ihrer Entwickler ist, investieren Sie etwas Mühe in die Erstellung einer einfachen Indexseite und halten Sie diese auf dem neuesten Stand (entweder machen Sie es selbst oder bitten Sie die Leute, ihre Beiträge mit dem Index zu verlinken).Auf diese Weise könnte das Wiki zu einer sehr schönen und recht umfassenden Dokumentationssammlung für Ihre gesamte Arbeit werden.

Andere Tipps

Einige Hinweise:

Jedes Mal, wenn jemand Informationen per E-Mail sendet, die eigentlich in ein Wiki gehören sollten, erstellen Sie eine Seite für dieses Thema und fügen Sie hinzu, was er in die E-Mail eingegeben hat.Antworten Sie dann: „Danke für diese Info. Ich habe sie hier ins Wiki gestellt, damit sie in Zukunft leichter zu finden ist.“

Wenn Sie Informationen haben, die Sie weitergeben müssen und die im Wiki enthalten sein sollten, platzieren Sie sie dort und senden Sie einfach eine E-Mail mit einem Link dazu, anstatt den Leuten eine E-Mail zu schicken.

Wenn Sie Leute um Informationen bitten, formulieren Sie diese so, dass die Veröffentlichung einer solchen Dokumentation im Wiki als Standard oder Standard angesehen werden sollte:„Ich habe im Wiki gesucht, konnte es aber nicht finden.Hast du diese Informationen schon dort gepostet?“

Wenn Sie der „Wiki-Champion“ sind, stellen Sie sicher, dass andere Leute wissen, wie man es benutzt, z.„Habe ich schon mit Ihnen besprochen, wie man eine neue Seite erstellt?“

Bearbeiten Sie die Seitenleiste, um sicherzustellen, dass sie für Ihre Arbeit relevant ist.

Verwenden Sie auf verwandten Seiten Vorlagen im „Navigationsfeld“-Stil, um die Navigation zu erleichtern.

Platzieren Sie etwas wie {{Special:NewPages/5}} auf der Startseite oder aktuelle Änderungen, damit die Leute die Aktivität sehen können.

Werfen Sie alle paar Tage oder Wochen einen Blick auf die letzten Änderungen. Wenn Ihnen auffällt, dass jemand unaufgefordert Informationen hinzufügt, senden Sie ihm eine E-Mail oder kommen Sie vorbei und machen Sie ihm ein kleines Kompliment.

Wir nutzen ein Wiki in der einen oder anderen Form schon seit einiger Zeit, aber es dauert eine Weile, bis die Leute mitmachen.Sie werden vielleicht feststellen, dass Sie eine Zeit lang der Einzige sein werden, der Artikel schreibt, aber haben Sie Geduld, irgendwann werden andere Leute mit an Bord kommen.

Wenn jemand eine E-Mail verschickt, die Informationen zum Projekt enthält, weisen Sie ihn hilfreich auf das Wiki hin – und machen Sie so weiter – er sollte den Hinweis verstehen.

Wir haben ein SharePoint-Portal und verwenden das Wiki von dort aus – wir haben es mit unserem eigenen Branding angepasst, damit es „passt“ – ich habe wirklich das Gefühl, dass dies dazu beigetragen hat, die Akzeptanz zu verbessern.

Stellen Sie sicher, dass sich jeder darüber im Klaren ist, dass das Wiki noch informeller ist als E-Mail....weil es einen „Angstfaktor“ geben wird, dass die Leute denken könnten, dass alles, was sie dem Wiki hinzufügen, übermäßig analysiert wird.

Ich denke, dass die meisten bisherigen Antworten genau richtig sind – je mehr man sich selbst damit beschäftigt, desto größer wird die Menge an nützlichen Informationen, sodass die Leute langsam aber sicher ganz natürlich anfangen werden, sie zu nutzen.

Der andere Ansatz, den Sie verwenden könnten, ist dieser:Schlagen Sie vor, jedes Mal, wenn jemand einem anderen Teammitglied eine Frage zum Projekt stellt, die Frage wie gewohnt zu beantworten, die Antwort aber auch einem Abschnitt des Wikis hinzuzufügen.Dies kann ein paar Minuten länger dauern, bedeutet aber, dass Sie Zeit sparen können, wenn jemand das nächste Mal dieselbe Frage stellt (was zwangsläufig der Fall sein wird), indem Sie ihn auf das Wiki verweisen.Dies wiederum sollte den Leuten helfen, das Wiki als erste Informationsquelle zu nutzen, und die allgemeine Akzeptanz fördern.

Sie können Entwickler nicht dazu zwingen, etwas zu tun, wofür sie keinen Anreiz haben;leider Wikis, wie Dokumentation (naja, eigentlich Wikis Sind Dokumentation) haben für Entwickler selten einen „coolen“ Wert.Außerdem stecken sie bereits tief in der Entwicklungsarbeit – könnte man sie wirklich mit einem Wiki belästigen?

Abgesehen davon sollten die Leute, die das Wiki vorangetrieben haben (z. B. Sie), in erster Linie für die Aktualisierung verantwortlich sein, und wenn Sie es ernst meinen, würde Ihnen wirklich eine Menge Arbeit bevorstehen.

Sie könnten auch das ff ausprobieren:

Sie sagen, es ist nicht sehr strukturiert – viele Leute werden von schlecht strukturierten Wikis (schwer zu durchsuchen/durchsuchen) abgeschreckt.Vielleicht können Sie das also zuerst beheben
Vielleicht können Sie leitende Entwickler/Projektmanager bitten, es mit Dingen zu füllen, die für sie ein Problem darstellen:Dinge wie Codekonventionen und API-Design für Ihr spezielles Projekt
Mit gutem Beispiel vorangehen:religiös dokumentieren dein Teil des Systems.Durch die Schaffung eines Präzedenzfalls können andere dazu ermutigt werden, dasselbe zu tun

Verkaufen Sie den Entwicklern die Idee, das Wiki zu nutzen.Sie haben einige Vorteile identifiziert, teilen Sie diese mit den Entwicklern.Wenn sie sehen, dass sie etwas Wertvolles daraus ziehen, werden sie anfangen, es zu nutzen.

Beispielvorteile von Was ist ein Wiki?

Gut zum Aufschreiben schneller oder längerer Ideen, sodass Sie mehr Zeit für formelles Schreiben und Bearbeiten haben.
Sofortige Zusammenarbeit ohne Versenden von Dokumenten per E-Mail, sodass die Gruppe synchron bleibt.
Von überall mit einer Internetverbindung zugänglich (wenn es Ihnen nichts ausmacht, in Webbrowser-Textformen zu schreiben).
Ihr Archiv, denn jede Seitenrevision wird aufbewahrt.
Aufregend, unmittelbar und bestärkend – jeder hat das Wort.

Ich habe etwas verkauft und sogar einige Schulungen durchgeführt.Ich glaube, einige Leute sind von der fehlenden WYSIWYG-Bearbeitung und der fehlenden Möglichkeit, formatierten Text aus Word oder Outlook einzufügen, abgeschreckt.Ich weiß, dass es einige Tools gibt, mit denen man diese Probleme umgehen kann, aber sie stellen immer noch Hindernisse dar.

Es gibt einige Bereiche, in denen das Wiki zum Protokollieren bestimmter Bereiche verwendet wird, aber Leute, die diese aktualisieren, machen nichts anderes damit.

Ich werde das Wiki trotzdem zur Dokumentation meines Fachgebiets nutzen, da es als praktische Gehirnerweiterung dient.Wenn ich eine neue Entwicklung beginne, verwende ich sie als Notizblock für Ideen, die ich im weiteren Verlauf erweitern kann.

Es wäre hilfreich, wenn das Management dies lautstark unterstützen würde, auch wenn dies nicht verpflichtend ist.

Es fällt mir schwer, die Leute dazu zu bringen, es tatsächlich zu nutzen, geschweige denn einen Beitrag zu leisten.

Eine der einfachsten Möglichkeiten, Leute dazu zu bringen, Beiträge zu einem Wiki zu leisten, besteht darin, sie Inhalte tatsächlich auf Wiki-geeignete Weise bereitstellen zu lassen, d. h.sodass alles, was sie über ihre üblichen Kommunikationskanäle (Newsgroups, Mailinglisten, Foren, Issue-Tracker, Chat) veröffentlichen, grundsätzlich für die Aufnahme in das Wiki geeignet ist.

Damit andere (Benutzer/Freiwillige) solche Inhalte einfach übernehmen und ins Wiki stellen können.

Das hört sich komplizierter an, als es in Wirklichkeit ist, es geht vor allem darum, Fragen und Antworten so zu verallgemeinern, dass sie nicht unbedingt Teil eines Gesprächs sind, sondern für sich allein verständlich, sinnvoll und nützlich sein können.

Zum Beispiel eine Frage wie diese:

Wie bringe ich Git dazu, ein Remote-Repository zu klonen???

Kann so beantwortet werden:

Hallo, benutze einfach Git Clone Git: // ...

Fragen können aber auch weniger persönlich beantwortet werden:

Um ein Git-Repository zu klonen, sollten Sie den Clone-Parameter für Git verwenden:git clone git://....

Was ich sagen möchte, ist, dass die meisten Diskussionen in einem Projekt problemlos zur Dokumentation genutzt werden können und sollten.Mit dieser Denkweise kann Ihre Dokumentation tatsächlich ziemlich schnell wachsen.Sie müssen den Leuten nur klar machen, dass nützliche Informationen idealerweise auf eine Art und Weise bereitgestellt werden sollten, die für die Einbindung in Wikis geeignet ist.

Ich habe mehrere Fälle erlebt, in denen Open-Source-Projekte begonnen haben, diesen Ansatz in gewissem Umfang zu verwenden, und während sich einige Leute (größtenteils neue Benutzer) darüber beschwerten, dass die Antworten nicht sehr persönlich waren, nahm der Umfang der Dokumentation stetig zu, weil andere Leute solche Diskussionen einfach nur beobachteten Ich habe damit begonnen, solche Antworten in das Wiki zu kopieren/einzufügen.

Im Grunde ist dies eine der einfachsten Möglichkeiten, Menschen dazu zu bringen, zu einem Wiki beizutragen, ohne dass sie es selbst nutzen müssen. Das Einzige, was von ihnen verlangt wird, ist ein Umdenken.

Wenn die Entwickler weiterhin eine „echte“ Dokumentation pflegen müssen (s.a.Word-Dokumente) sehe ich keine Möglichkeit, dies sinnvoll in einem Wiki zu duplizieren.

Es macht keinen Sinn, dass jemand zweimal schreibt
Es besteht die Gefahr, dass doppelte Daten bald nicht mehr synchron sind.

Mein aktueller Kunde hat das alles ins Wiki verschoben.Ich dokumentiere also nur einmal, und das mache ich An das Wiki.

Das ist in Ordnung.Die Arbeit mit Wiki ist mühsamer als mit Word, aber zumindest ist das Dokument online und andere können damit arbeiten.

Eine andere funktionierende Lösung (imho) wäre, Dokumente neben der Quelle auf Subversion zu speichern.Dann muss das zusammenführende System aber auch mit Rich Text usw. zurechtkommen.sowie.Ich weiß nicht, ob es dafür eine Lösung gibt (außer der Verwendung von HTML oder LaTex, was eigentlich keine schlechte Wahl wäre).

Finden Sie „klebrige“ Gegenstände (Unterseite 3, S.Dokumente/Diagramme/usw.) etwas, das das Team offenbar immer wieder erstellt und im Wiki veröffentlicht.Stellen Sie sicher, dass jeder Zugriff auf das Wiki hat und weiß, dass es dort ist – richten Sie nach Möglichkeit einen Benachrichtigungsmechanismus ein.Mit etwas Glück sollten sie beim nächsten Zugriff auf das Wiki zugreifen, anstatt es der Versionskontrolle oder ihren Computern zu entziehen.Wenn dies immer noch nicht der Fall ist, versuchen Sie herauszufinden, ob das Team genügend Spielraum hat, um das Wiki tatsächlich zu nutzen. Der Grund für ihre Zurückhaltung könnten subtilere Probleme sein.

Schauen Sie sich die Ratschläge an http://www.ikiw.org/ Erweitern Sie Ihr Wiki

Nur um einige der hervorragenden Ratschläge zu ergänzen, die hier angeboten werden ...

Als Entwickler in einem kleinen Unternehmen, das größtenteils keine Auftragsarbeiten im Zeitraum von 6 bis 24 Monaten durchführt, muss ich feststellen, dass meine Zeit oft zwischen der Entwicklung und dem Schreiben von Statusberichten (auf Augenhöhe mit dem Schreiben von Dokumentationen, nur noch schlimmer!) aufgeteilt wird Ein Wiki, mit dem wir unorganisierte Gedanken und Notizen niederschreiben können, während wir weitermachen, hat das Schreiben von Berichten viel weniger schmerzhaft gemacht (nicht schmerzfreier, aber trotzdem besser).

Wenn Sie sich bereits in der Mediawiki-Welt befinden, sollten Sie sich außerdem Folgendes ansehen SemanticMediawiki.Es ermöglicht Ihnen, die Organisation Ihrer Daten auf eine andere Ebene zu heben, indem Sie sie semantisch markieren.Ich weiß, das allein bedeutet nicht viel, aber ich kann Ihnen (zum Beispiel) sagen, dass es die Relevanz der von Suchanfragen zurückgegebenen Daten drastisch verbessern kann.Es ist auf jeden Fall einen Blick wert.

Generell gute Beratung hier.Ich möchte hinzufügen:

Du wirklich brauchen A Champion - Jemand, der dies den Entwicklern und dem Management mitteilt (ohne es zu sein). aufdringlich - das ist eine Herausforderung!) und Bereitstellung von Support und Tutorials, wenn möglich.Diese Person muss außerdem ein Peer sein (also ein Mitentwickler, nicht jemand in einer Remote-IT-Abteilung) und wirklich kundenorientiert sein, d. h.bereit, auf Anfrage Änderungen vorzunehmen.
Apropos Veränderungen, sagen einige hier Wikis sind unstrukturiert.Ich bin nicht einverstanden.Unsere MediaWiki-Installation ist nach Kategorien strukturiert, insbesondere mit zwei Erweiterungen:WarnNoCategories (damit Benutzer beim Speichern einer Seite eine Kategorie hinzufügen müssen) und Kategoriebaum um zu zeigen, wie alle Kategorien zusammenpassen (dies kann über die Seitenleiste verlinkt werden).Wenn Sie interessiert sind, habe ich noch weitere Tipps, wie wir diese niedrige Schwelle einhalten können.

Lizenziert unter: CC-BY-SA mit Zuschreibung

Nicht verbunden mit StackOverflow