Die Aufrechterhaltung eines Programmierers Wiki [geschlossen]

Question

Ich war vor kurzem verantwortlich für die Wiki für das Entwicklungsteam setzen. Das Wiki ist noch in den Kinderschuhen steckt, so habe ich viel Platz zu arbeiten. Es Ziel ist intern an das Entwicklungsteam zu beherbergen. Derzeit ist der Hauptteil der Informationen, die das Wiki hält Standards ist Coding.

• Was sind einige bewährte Verfahren, Dev-Team für seine internen Wiki verwendet?
• Welche Informationen sind wichtig auf einem Entwickler-Wiki haben?
• Wenn Sie Ihr Entwickler-Team in das Wiki gehen sind, welche Informationen würden Sie erwarten, zu sehen?
• Sie haben einige Informationen, die nicht auf dem Wiki gehen sollte, auch wenn es wie eine gute Idee zu sein scheint?

- bearbeiten -

• Auch ist es eine gute Möglichkeit, die Informationen zu organisieren? (Wie beispielsweise durch die Schicht (Daten, ui), durch porject oder andere)

Answer 1

• Einführung in die Source-Basis für neue Programmierer
• Allgemeine Dokumentation (nicht die API-Dokumentation per se, aber mehr Tutorial wie Dinge)
• Listen von Mitarbeitern / wer was macht und wie sie erreichen
• Notes / resources / Artikel, die Konzepte, die in der Software
erklären
• Dokumentation des Build-Prozesses und die Dateisystem-Layout der Code-Basis

Andere Dinge, die ich in der Regel setzen gibt es

• Planung / ToDo-Listen
• Informationen, die interessant ist, für andere lesen
• Alles andere, was ich fühle, sollte geteilt werden

Answer 2

Wir hatten eine Entwicklung Wiki und es war ein großartiges Werkzeug. Wir haben es für alles

• Wenn Brainstorming neue Ideen, würden wir sie im Wiki erfassen. Die geringe Reibung Natur des Wikis machte es einfach für jedermann in der Organisation (wir waren eine kleine Startup) Ideen hinzufügen, wie sie von ihnen gedacht. Wir hatten ein hohes Niveau „Brainstorming“ Seite, die auf detaillierte Seiten verknüpft eine ausführliche Beschreibung der einzelnen Idee enthält.
• Für jede Iteration, sollten wir „bewegen“ Feature Idee Elemente aus dem „Brainstorming“ Liste der Feature-Liste für diese Iteration. Die Einzelheiten der Funktion wurden ausgespült Design und Implementierung Details aufzunehmen.
• Als Merkmale abgeschlossen wurden, die Iteration Seite unsere Release Notes Seite wurde -., Die auch die Release-Tag von Versionskontrollsystem enthalten
• Wir hatten eine Bug-Seite, die sehr ähnlich zu den Feuilletons gearbeitet. Fehlerbehebungen wurden an die Iteration / Release-Seiten hinzugefügt, wie sie auf / vollständig gearbeitet wurden.
• Wir haben auch unsere Benutzerdokumentation im Wiki und exportiert diese Seiten es mit der Veröffentlichung.

Im Laufe der Zeit. Dieses Tool wurde mehr und mehr wert angesehen. Wir haben dann für verschiedene neue Wikis zu schaffen, die Produkte der Firma arbeitete.

Ich hoffe, dass Sie Ihre Entwicklung Wiki finden so nützlich, wie wir es gemacht haben!

Answer 3

Wikipatterns ist eine Website, auf die Dokumentation von Best Practices Wiki gewidmet ist. Sie auch anti-Muster beschreiben und über die Möglichkeiten, um mit ihnen zu sprechen. Ich las ihr Buch, und es war ein großer Gewinn für mich ein Wiki über den Boden in einer 150+ Person Organisation zu erhalten.

Answer 4

Eine Sache, die wir auf unserem dev Wiki betonen ist, dass es aktualisiert wird, wenn die Dinge ändern. Wir wollen nicht unsere Wiki, die Informationen sollten liefern und eine zentrale Quelle des gesammelten Wissens sein, so zu werden veraltet, dass es nutzlos ist. Da der Code aktualisiert wird, sind die Entwickler eine mit ihm verbundene Informationen im Wiki zu aktualisieren angefordert.

Anders als Coding Standards, halten wir Tipps und Tricks für unsere Code-Basis arbeiten, Setup-Informationen für neue Mitarbeiter und allgemeine Umgebungsinformationen.

Answer 5

• Burndown Charts
• gemeinsame Setup-Informationen für Entwicklungsumgebungen (schön für, wenn neue Leute beginnen)
• Specs
• Bekannte Probleme und Abhilfen mit Entwicklungs-Tool

Answer 6

Kommen Sie mit irgendeiner Art von Style-Guide auf, und andere lehren, wie Sachen stylen. Als ich verantwortlich für ein Unternehmens-Wiki, würde alle anderen Entwickler nur unschön Prosa schreiben, die kaum formatiert wurden, und sah schrecklich aus.

Halten Sie weg von Dingen, die Diskussion bedürfen. Ich habe versucht, Schuhanzieher in einer Buchbesprechung Abschnitt, aber es war zu schwierig, andere auf Dinge zu äußern zu haben.

Beispiele für in Haus Bibliotheken sind gut. Und / oder „Storyboards“ einen Benutzer durch einen Prozess gehen, wenn MethodX aufgerufen wird.

Answer 7

Was sind einige bewährten Verfahren, Dev-Team für seine interne Wiki verwendet?

Machen Sie es schön aussehen. Ich weiß, es ist nicht wichtig klingt, aber wenn Sie ein wenig Zeit damit verbringen, Branding lohnt es sich in Bezug auf die Menschen aus tatsächlich es zu benutzen. Und die Aufnahme ist der Schlüssel, oder es wird nur welken und sterben.

Welche Informationen sind wichtig, auf einem Entwickler-Wiki haben?

• Allgemeine Informationen über ein Projekt, Meilensteine, Liefertermine usw.
• Zusammenfassungen der Designentscheidungen / Treffen. Wichtig, so dass Sie nicht wieder besuchen die gleichen Bereiche immer und immer wieder.
• HowTo Führungen für die allgemeine Entwicklung der laufenden Projekte
(zum Beispiel, wie ein neues Plugin zu entwickeln)

Wenn Sie Ihr Entwickler-Team in das Wiki gehen waren, welche Informationen würden Sie erwarten zu sehen?

Projektinformationen, die daran arbeitet, was usw. Design-Entscheidungen. Auch Best Practices und Links zu nützlichen Websites.

Gibt es einige Informationen, die nicht auf dem Wiki gehen sollte, auch wenn es wie eine gute Idee zu sein scheint?

Low-Level-Aufgabenlisten sind in der Regel schwanken und nicht auf dem neuesten Stand gehalten werden, und können irreführend sein. Auch kritische Kommunikation zwischen den Abteilungen sind besser geeignet, um E-Mail, dann kann das Gespräch in das Wiki kopiert werden. Es ist zu einfach es sonst zu ignorieren!

Answer 8

Beachten Sie, dass ein Wiki interaktiv ist. Wenn Sie über das Veröffentlichen denken, wie in Burndown Charts zu veröffentlichen, dann denken Sie nicht weit genug. dass die Verteilung von Informationen ist nur ein Teil davon.

Zum Beispiel, anstatt eine „Current Burndown Chart“ Seite, eine Seite für „Burndown Chart für Woche der 2008.10.27“ erstellen und dann wird die Menschen ermutigen, auf dem Chart zu kommentieren, und was es bedeutet, und warum Sie tat so schlecht, dass Woche.

Answer 9

Der schwierigste Teil ist immer Entwickler Wiki zu verwenden. Ich habe einige langjährige Vorschläge hier: http://possibility.com/wiki/index. php? title = GettingYourWikiAdopted

Wie Sie einen Wiki Angenommen ist Tough

Haben Sie einen Meister

Entfernen Einwände

Inhalte erstellen

verstricken das Wiki in Unternehmen Prozesse

evangelisieren

Geben Sie nicht

Betrachten Nicht Wiki Verwendung Für Gespräche

Just Do It! Warten Sie nicht für ein Budget

Haben Sie einen Übergangsplan

Die Förderung des Wiki

Eine gute Praxis ist für jeden Build verfügbar durch das Wiki die gesamte Dokumentation und den Quellcode zu haben. Dann gehen Entwickler Wiki Build Informationen zuzugreifen und das macht es von unschätzbarem Wert.

Answer 10

Wikis kann eine wertvolle Ressource für Software-Entwicklungsteams, aber sie sind kein Allheilmittel. Es ist nur allzu leicht, eine Wiki zu erstellen, die schnell in Vergessenheit oder wurden grob veraltet fallen würden.

Meiner Meinung nach ist der Schlüssel zu einem erfolgreichen Wiki wird immer das gesamte Team an Bord. Das heißt, die Menschen weg von anderen Ressourcen (insbesondere E-Mail-Archive) als Wissensspeicher erhalten, und einen Anreiz bieten für Menschen beizutragen.

Es ist jedoch auch wichtig, nicht ein Format czar zu sein: Wenn Sie eine Menge von Dokumenten, die Sie erzeugen in, sagen wir, MS WORD, kann es ideal sein, sie alle in der Wiki-Format zu tun, aber das braucht Zeit und kann wenn Sie ärgerlich Diagramme haben, Dokumente, etc. in diesen Fällen ist es besser, zu gefährden und damit die Menschen sie halten im Word-Format, solange die einzige Möglichkeit, die neueste Version für den Zugriff auf durch das Wiki ist.

Wenn Sie keinen Manager sind, müssen Sie einen Manager an Bord zu bekommen, weil es einige „Durchsetzung“ erfordern würde.

Es hat sich auf Wikis Forschung und Erfahrung angesammelt und deren Verwendung in der Softwareentwicklung. Sie können die ACM Digital Library, zum Beispiel suchen. Ich bin ein Mitorganisator einer jährlichen Workshop über Wikis für SE und wir hatten einige interessante Erfahrungsberichte und gibt es zusätzliche Materialien im internationalen Symposium über Wikis.

Answer 11

Wir beherbergen und Inhouse-Team Wiki. Und da haben wir alle notwendigen Informationen für jedes Projekt entwickeln wir:

• Repositories
• Adressen für virtuelle Maschinen
• Passwörter
• Projektdokumentationen
• Projektübersicht
• Projektstatus

und alles, was wir Bedürfnisse füllen an einem Projekt geschrieben werden. Und es ist die nützlichsten Web-Anwendung laufen wir (neben Mantis ). Auf allgemeinere Seiten stellen wir eine Definition jeder Taxonomie wir, allgemeine Projektrichtlinien, Policen, Programmierung und Entwicklung Praktiken verwenden, die wir verwenden. Es ist da, es ist einfach und effektiv, und ich denke, dass jedes Team eine von denen haben sollte.