Suchen Sie nach einer Best-Practice-Struktur zum Einrichten eines Wikis für Entwickler?

Ich werde ein Team leiten, das nicht die beste Erfolgsbilanz für Dokumentation, Kommunikation und Wissensaustausch hat. Ich möchte ein Framework einrichten, um dem Team den Einstieg in diesen Bereich zu erleichtern.

Konzentrieren Sie sich nicht zu sehr darauf, eine perfekte Struktur im Voraus zu erhalten, sondern lassen Sie sie besser organisch wachsen . Auf die Kommunikationskultur und den Kommunikationsprozess kommt es an.

Im Folgenden finden Sie einige Tipps zur Pflege des Team-Wikis.

Grundlagen

Wert Feedback

Bitten Sie um Feedback, sammeln Sie es und zeichnen Sie es auf - E-Mail, Kommentare zu Wiki-Seiten (übrigens am bequemsten), Messenger, Konversation.

• Feedback aufzeichnen

  • F: Was ist, wenn ich derzeit keine Zeit habe, die Informationen ordnungsgemäß zu verarbeiten?
  • A: Speichern Sie es auf der Seite wie es ist - für die zukünftige Verarbeitung und verstecken Sie es wie folgt vor normalen Lesern:{excerpt:hidden=true}information to be processed later{excerpt}

• Feedback verarbeiten

  • versuche es so schnell wie möglich zu machen. Details und Zusammenhänge, die für Sie oder den Einsender im Moment offensichtlich sind, können einen Tag, eine Woche oder einen Monat später vergessen werden  
  • Erwägen Sie alternative Lösungen für Probleme, auf die im Feedback hingewiesen wird. Beispiel:
    • (Feedback) Hey, die Informationen, die ich brauche, sind gemischt mit nutzlosen
    • (falsche Aktion) OK, ich entferne Dinge, die Sie nicht brauchen
    • (richtige Aktion) OK, ich werde die Informationen auf eines Ihrer Interessen und den Rest aufteilen, der für jemand anderen von Interesse sein könnte

Umgang mit Vorschlägen, die langfristige Arbeit implizieren

• F: Was ist, wenn der Vorschlag lautet: "Sammeln Sie alle relevanten Daten, die auf tausend anderen Seiten dokumentiert sind, und ordnen Sie sie neu an"?
• A: Fügen Sie Ihrer Seite einen TODO-Abschnitt hinzu (falls dieser noch nicht vorhanden ist) und notieren Sie den Vorschlag in diesem Abschnitt. Später können Sie damit auch Ihren Fortschritt verfolgen
  update DD.MM.YYYY: 475 pages of 1000 are processed

Umgang mit Vorschlägen, die für Sie falsch aussehen

Nebenbei bemerkt, es tut nie weh, den Einreicher des Vorschlags um Klärung zu bitten. Sie sollten jedoch zuerst Ihren Teil der Arbeit erledigen:

• Überprüfen Sie den Seitenverlauf unter Berücksichtigung des Überprüfungsdatums. Es besteht immer die Möglichkeit, dass der Übermittler auf das Problem einer älteren Version verweist, die bereits behoben wurde
• Schauen Sie sich die Seite / den Abschnitt, auf die verwiesen wird, genauer an und fragen Sie sich, was ihn / sie dazu veranlassen könnte, so zu denken.
• (Nach einem kleinen Training mit einem Trick wie oben) werden Sie feststellen, dass es in den meisten, wenn nicht allen Fällen einen bestimmten Bereich für Verbesserungen gibt.
  • Stellen Sie sich zum Beispiel vor, ein Benutzer beschwert sich über fehlende Informationen, die tatsächlich irgendwo auf der Seite vorhanden sind. Obwohl eine solche Beschwerde an der Oberfläche falsch aussieht, weist sie häufig auf ein ernstes Problem auf der Seite hin: Einige wichtige Informationen sind schwer zu finden. Wenn Sie ihm eine Sichtbarkeit geben, die er verdient, wird die Seite verbessert.

besser schnell als perfekt

Verlassen Sie sich auf Bewertung und Feedback. Wenn etwas wirklich korrigiert werden muss, wird die Zeit es für Sie regeln

• Dies gilt auch für die Selbstbewertung. Notieren Sie den Entwurf dessen, was Sie auf die Seite stellen möchten, und überprüfen Sie ihn eine Stunde (oder einen Tag oder eine Woche) später selbst - dieser Trick kann Wunder wirken
• Verschwenden Sie keine Zeit damit, die Dinge beim ersten Versuch perfekt zu machen - es ist unmöglich
  • Notieren Sie die Informationen, sobald sie kaum akzeptabel erscheinen, und bitten Sie die Interessenten, sie zu überprüfen

sei mutig

Seien Sie beim Aktualisieren von Seiten mutig: Beheben Sie Probleme , korrigieren Sie die Grammatik, fügen Sie Fakten hinzu, stellen Sie sicher, dass der Wortlaut korrekt ist usw.

• Das obige basiert auf dem Wikipedia-Prinzip und wird am besten bei Wikipedia erklärt
  • ... aber bitte seien Sie vorsichtig - kümmern Sie sich um das Gemeinwohl und bearbeiten Sie nicht rücksichtslos: eine Klarstellung des oben genannten Prinzips,
    ebenfalls bei Wikipedia erklärt

fortgeschritten

sei dankbar

Menschen, die Feedback geben, sind ein wertvolles Gut. Seien Sie ihnen dankbar. Diese Personen haben sich Zeit und Mühe gegeben, um nicht nur Ihre Seite zu lesen, sondern auch ihr Feedback zu geben. Die große Mehrheit Ihrer Benutzer wird Ihnen gegenüber nicht so großzügig sein. Diejenigen, die ihre Gedanken teilen, sind "die Creme" Ihres Publikums. Seien Sie dankbar für ihren Beitrag.

TLA-s erklären

Wenn Sie nicht herausfinden können, was TLA ist? - Du hast den Punkt

• Verwenden Sie dazu nach Möglichkeit Links: TLA

Antworten auf Fragen aufzeichnen

Respektiere die Zeit anderer - nimm die Antworten auf

• Es kann eine Sekunde dauern, bis Sie die Frage beantwortet haben, aber denken Sie an den Mann, der sie stattdessen gestellt hat? (S) Er nahm sich Zeit, um Ihre Seite zu lesen, um zu versuchen, die Antwort zu finden, um Sie zu kontaktieren und auf Ihre Antwort zu warten. Wenn Sie die Antwort auf der Seite aufzeichnen, sparen Sie die ganze Zeit für den nächsten Mann, der diese Frage hat.
• Notieren Sie Antworten auf Ihre eigenen Fragen. Was für Sie unklar ist, könnte für den nächsten Leser unklar sein.

Fragezeichen verwenden

Verwenden Sie im Zweifelsfall Fragezeichen

• Confluence- Syntax als Beispiel: (?) Beispiel:<this info> needs checking
• Auf diese Weise kann jeder Leser klar erkennen, welche Art von Informationen Sie benötigen. Die Chancen stehen gut, dass Ihnen jemand bei der Klärung helfen kann

Links sind deine Freunde

• TROCKEN - Versuchen Sie nicht, Informationen zu kopieren, wenn Sie stattdessen den Link bereitstellen können
• lernen, bei Bedarf zusammenzufassen
  • irgendein Link - hey was ist das?
  • Einige Links - Wikipedia, die freie Enzyklopädie, die jeder bearbeiten kann.

Visuals sind wichtig

• Wenn Sie Zeit haben, überprüfen Sie Ihre Seite selbst und fragen Sie sich, ob es für den Leser einfach ist, die Punkte zu finden, zu denen Sie bereit sind
• Es kann ziemlich schwierig sein, Substanz in einem unstrukturierten Bewusstseinsstrom zu finden

  ^{...Ich gab ihm das Vergnügen, ihn weiterzuführen, bis er mich bat, ja zu sagen, und ich antwortete nicht zuerst mit Blick auf das Meer und den Himmel. Ich dachte an so viele Dinge, die er nicht über Mulvey und Mr. Stanhope und Hester und wusste Vater und alter Kapitän Groves und die Seeleute, die alle Vögel spielen, fliegen und ich sage, bücken und spülen Geschirr, das sie es nannten, auf dem Pier und dem Wachposten vor dem Haus des Gouverneurs mit dem Ding um seinen weißen Helm, dem armen Teufel, halb geröstet und den spanischen Mädchen Die Griechen und die Juden und die Araber und der Teufel lachen in ihren Schals und ihren hohen Kämmen und den Auktionen am Morgen und wissen, wer sonst noch aus allen Teilen Europas, der Duke Street und dem Geflügelmarkt vor Larby Sharons und den armen Eseln gluckst im Halbschlaf schlüpfen und die vagen Kerle in den Mänteln schlafen im Schatten auf den Stufen unddie großen Räder der Karren der Bullen und der alten Burg, die Tausende von Jahren alt sind, ja, und diese hübschen Mauren, alle in Weiß und Turbanen wie Könige, die Sie bitten, sich in ihr kleines Geschäft und Ronda mit den alten Fenstern der Posadas zu setzen 2 flüchtige Augen ein Gitter versteckte sich für ihren Geliebten, um das Eisen und die Weinläden zu küssen, die nachts halb geöffnet waren, und die Kastagnetten, und in der Nacht vermissten wir das Boot in Algeciras, dem Wachmann, der mit seiner Lampe und O diesem schrecklichen tiefen Strom O und dem Meer gelassen herumlief Das Meer purpurrot mag manchmal Feuer und die herrlichen Sonnenuntergänge und die Bäume in den Alameda-Gärten, ja und all die seltsamen kleinen Straßen und die rosa und blauen und gelben Häuser und die Rosengärten und das Jessamin und die Geranien und Kakteen und Gibraltar als Mädchen, wo ich war eine Blume des Berges ja, wenn ich die Rose wie die in meine Haare steckeAndalusische Mädchen benutzten oder soll ich ein rotes Ja tragen und wie er mich unter der maurischen Mauer küsste und ich dachte gut an ihn und einen anderen und dann bat ich ihn mit meinen Augen, noch einmal Ja zu fragen und dann fragte er mich, ob ich Ja sagen würde Ja, meine Bergblume und zuerst legte ich meine Arme um ihn. Ja und zog ihn zu mir hinunter, damit er meine Brüste spüren konnte. Ja, und sein Herz wurde verrückt und ja, ich sagte ja, ich werde ja.}

Entspannen Sie sich und haben Sie Spaß

Denken Sie daran, dass Leser Ihrer Seite normalerweise nicht todernst sein müssen.

• Wenn Sie der Meinung sind, dass es angebracht ist, Spaß zu haben, haben Sie es

Kampf Link Rot

• Sie sind bereit, eine Seite oder Ressource zu verschieben?
  Gut, denken Sie nur an die Leute, die irgendwo in ihren Lesezeichen, E-Mail-Archiven, Dokumenten usw. usw. Links dazu haben
• Wenn Sie die Seite oder ein Dokument (erneut) verschieben, behalten Sie einen Platzhalter dort, wo er sich zuvor befand, damit die Besucher verstehen, was damit passiert ist und wohin sie stattdessen gehen sollen
  • <this page> has been moved to <that page>
  • <this document> has been removed because of <the reason>

Referenzen zur weiteren Lektüre

• Wikipedia Richtlinien und Richtlinien
• Leitfaden zur Konfluenznotation
• Wiki-Muster

Zunächst ist es wichtig, ein gutes Wiki zu wählen. Wählen Sie eine, die:

1. Ist gut gepflegt und hat gute Unterstützung.
2. Unterstützt die Benutzerauthentifizierung und hat Zugriffskontrolle für Dokumente oder Namespaces.
3. Verfolgt Änderungen an Dokumenten und liefert einen Verlauf.
4. Ermöglicht die E-Mail-Benachrichtigung über Dokumentänderungen.
5. Hat einen guten Editor, vorzugsweise WYSIWYG, und unterstützt Listen, Tabellen und das Hochladen von Bildern.

Das größte, was ein Entwicklungsteam-Wiki braucht, ist ein "Gärtner": jemand, der für die Festlegung des Layouts und der Struktur von Dokumenten im Wiki verantwortlich ist. Es muss keine Vollzeitrolle sein, aber der Gärtner sollte ein gutes Englisch und die Fähigkeit haben, Dinge gut zu erklären. Der Gärtner sollte Standardvorlagen für Seiten und Namenskonventionen erstellen und festlegen, welche Namespaces erforderlich sind.

Der Gärtner ist nicht dafür verantwortlich, den Inhalt zu erstellen und seine Struktur stärker durchzusetzen. Wenn beispielsweise jemand eine Änderung an einem Produkt vornimmt, ist der Gärtner nicht dafür verantwortlich, die Änderung am Wiki vorzunehmen. Der Gärtner ist jedoch dafür verantwortlich, dass die Änderung vorgenommen wird und gemäß den Richtlinien erfolgt (z. B. nicht nur auf einer separaten, nicht verknüpften Seite). Der Gärtner kann die Änderungen überprüfen oder an eine andere Person delegieren.

Es ist wichtig, das Wiki so zu strukturieren, dass es den Bedürfnissen des Publikums entspricht und nicht den Bedürfnissen derjenigen, die Inhalte erstellen. Wenn Sie beispielsweise über eine dedizierte Benutzeroberfläche oder ein Sicherheits- oder Lokalisierungsteam für die Softwareentwicklung verfügen, sollten Sie deren Informationen nicht in separate Abschnitte einfügen. Platzieren Sie sie in demselben Abschnitt, den die Entwickler betrachten. Wenn Sie alles zusammen haben, ist das Auffinden viel einfacher, es wird sichergestellt, dass Dinge nicht übersehen werden, und veraltete Inhalte werden schneller identifiziert.

Ein Wiki braucht eine veränderte Denkweise. Viele Unternehmen sind es gewohnt, dass ihnen Informationen aufgezwungen werden. Ein Wiki ermöglicht es den Verbrauchern der Informationen, diese zu ändern. Dies sollte nachdrücklich gefördert (und gegebenenfalls belohnt) werden. Wenn Ungenauigkeiten ein Problem darstellen, lassen Sie die Prüfer das Wiki so konfigurieren, dass sie bei Änderungen per E-Mail benachrichtigt werden.

Ein Entwicklungs-Wiki benötigt eine Strategie für die Versionierung. Was passiert, wenn Sie eine Reihe von Dokumenten für Version 1.0 haben, wenn Version 2.0 veröffentlicht wird? Einige der Dokumente für Version 1.0 gelten möglicherweise noch für 2.0, andere werden möglicherweise ersetzt. Was ist, wenn nach der Veröffentlichung von 2.0 eine Änderung an einem 1.0-Dokument vorgenommen wird?

Ein Wiki braucht eine Möglichkeit, den Erfolg zu messen. Wie viele Leute benutzen es? Haben sie gefunden, wonach sie gesucht haben? Sie benötigen nicht unbedingt ein großes, unansehnliches Bewertungs- und Kommentarfeld am Ende der Seite, aber ein einfacher Link "E-Mail an einen Menschen über diese Seite senden" kann hilfreich sein.

Schließlich ändern sich die Nutzungsmuster eines Wikis im Laufe der Zeit. Denken Sie daran, alle Standards regelmäßig zu überprüfen, um sicherzustellen, dass sie weiterhin den Anforderungen des Wikis entsprechen.

Es ist zwar eine gute Idee, dass alle Projekt-Wiki-Seiten einem ähnlichen Thema folgen, damit jeder weiß, wo Dinge zu finden sind, aber dies wird das Problem der Entwickler, die Seiten nicht aktualisieren, nicht wirklich lösen.

Sie müssen einen Weg finden, um Ihre Entwickler dazu zu bringen, genügend Nutzen daraus zu ziehen, dass sie es vorantreiben und wollen, dass es getan wird. Andernfalls sehen sie es einfach als eine weitere bürokratische Belastung von oben nach unten, auf die sie verzichten könnten.

Ich war in dieser Situation, sowohl dort, wo das Wiki völlig durcheinander war, als auch dort, wo es sehr gut organisiert und formal war. Der Status des Wikis hatte keinen Einfluss auf das Interesse der Entwickler.