Welche Art von Dokument für das Spieldesign? [geschlossen]

9

Welche Art von Unterstützung / Format verwenden Sie, um Ihre Spieldesign-Dokumentation zu speichern und zu verbreiten? Wiki? Doc-Dateien? Dateien im Repository? Freigegebenen Ordner? Google Doc?

Bitte geben Sie für jeden Vor- und Nachteile an.

Klaim
quelle

Antworten:

14

Ich verwende Google Text & Tabellen, da ich nur einen Online-Texteditor benötige. Ich kann relativ einfach online mit Menschen zusammenarbeiten und weiß, dass meine Informationen dort sicher sind, falls mein Computer abstürzt.

Eine weitere Option, die einen Blick wert ist, ist die Verwendung von Dropbox . Wenn Sie dort ein Word-Dokument ablegen, haben Sie sofort eine kollaborative Umgebung mit Versionskontrolle.

Sergio
quelle
5
PS Google Text & Tabellen ist seit dem letzten Update (glaube ich Mitte September) für die kollaborative Bearbeitung in Echtzeit absolut ERSTAUNLICH. Dropbox hingegen hat keine Konfliktlösung (es benennt eine widersprüchliche Datei um, was zu noch mehr Verwirrung führen kann), so dass es für die gleichzeitige Bearbeitung von Dateien ziemlich schrecklich ist, aber ideal für die Sicherung und Freigabe / nicht gleichzeitige Bearbeitung.
Ricket
Gibt es eine Möglichkeit, firmenlokale (als Firmenserver installierte) Google-Dokumente zu haben?
Klaim
1
@Klaim, wenn Sie Google Apps für Ihre Domain erhalten, können Sie. google.com/apps/intl/en/business/index.html
Jesse Dorsey
4
Noctrine, es wird immer noch von Google gehostet. Es wird nur in Ihrer Domain mit freundlicher Genehmigung eines CNAME-Eintrags angezeigt. Wenn sich die Daten physisch in Ihrem lokalen Netzwerk befinden müssen, funktioniert dies nicht. OTOH, sofern Sie keine Sicherheitsüberprüfung benötigen, um an Ihrem "Spiel" zu arbeiten, ist die letztere Anforderung in der Regel eher ein Hinweis auf Paranoia und Größenwahn als auf irgendetwas anderes.
drxzcl
1
Ja, ich kenne mich bereits mit Domains aus (ich habe bereits mehrere Google Apps für meine Domains), aber sagen wir, Sie haben keinen Zugang zum Internet, sondern nur zu einem lokalen Netzwerk?
Klaim
5

Wiki

Vorteile:

  • Die neueste Version ist immer über das Internet, von außerhalb usw. zugänglich.
  • Ziemlich einfach zu bedienen (wenn Sie sich von denen mit einem Zugunglück fernhalten, um Formatierungen wie MediaWiki vorzunehmen, das heißt)
  • Automatische Indizierung, Suche, einfache Kategorisierung
  • Es ist einfach, Änderungen Änderungen zuzuweisen und sie für Änderungen verantwortlich zu machen
  • Unterstützt das Verknüpfen und macht es einfach und effektiv, Details herauszufiltern
  • Kann direkt aus internen Fehlerberichten und anderen Korrespondenz auf Wiki-Seiten verlinken, wodurch die Überprüfung eines Fehlers sehr einfach wird
  • Versionsverlauf und Versionskontrolle sind normalerweise integriert

Nachteile:

  • Manchmal ZU leicht zu ändern (* siehe unten) und erfordert Disziplin
  • Seiten können nicht mehr synchron sein, wenn sie isoliert bearbeitet werden (häufig beispielsweise kein "globales Suchen und Ersetzen").
  • Seiten werden verwaist oder ersetzt und später als potenzielle Minenfelder für Codierer hinterlassen. ( "Was meinst du damit, dass wir das nicht mehr implementieren? Es ist immer noch im Design-Wiki!" )
  • Die Syntax kann etwas esoterisch sein, es sei denn, Sie erhalten das richtige Paket
  • Sie müssen das Hosting arrangieren oder akzeptieren, was online kostenlos verfügbar ist
  • Kein klarer Weg durch das Dokument - wie liest du alles?
  • Schwer zu drucken. Können Sie alles mit einem Klick ausdrucken? Können Sie einfach alles ausdrucken, was für eine bestimmte Funktion relevant ist, um sie in eine Besprechung aufzunehmen? Können Sie die digitale Version einfach mit Anmerkungen versehen, ohne das zugrunde liegende Dokument zu verdecken?

(* Wir haben ein Wiki für ein Projekt verwendet, und Designer waren immer versucht, Teile davon zu verbessern, selbst bei Funktionen, die abgemeldet und zur Codierung gesendet wurden. Als die Qualitätssicherung die Funktion testen musste, war dies der Fall wäre ein Albtraum, weil das Design oft etwas anderes vorschlägt als das, was tatsächlich codiert wurde, und es würde einiges an frustrierender Arbeit erfordern, um herauszufinden, was zuerst passiert ist, die Änderung des Designs oder des Codes.)

Kylotan
quelle
1
Alle Ihre Nachteile sind wirklich kein Problem, wenn Sie Confluence verwenden, mit Ausnahme des Hostings, das nur dann kostenlos ist, wenn Sie es auf Ihrem LAN-Server hosten und anderen erlauben, über DynDNS oder einen ähnlichen Dienst beizutreten.
LearnCocos2D
Lustige Sache ist, wir haben JIRA für unser Projekt verwendet. Ich denke, entweder hat niemand Confluence in Betracht gezogen oder die Kosten waren zu hoch. Ich habe deine Antwort trotzdem positiv bewertet.
Kylotan
Wiki-basierte Designdokumente ... Bitte, bitte ... Nicht.
Laurent Couvidou
3

Textdateien

In meinem aktuellen Projekt verwende ich einfache Klartextdateien in meinem Ordner "Docs" des Projekts, die im Repository neben dem Code gespeichert sind.

Vorteile:

  • Die Dokumentation wird in der Nähe der eigentlichen Arbeit aufbewahrt und ist daher leicht zu finden.
  • Durch die einfache Formatierung ist die Dokumentation einfach und schnell zu verwalten.
  • Ein einfaches Format bedeutet auch, dass das Risiko eines Dokumentationsverlusts aufgrund von Serverabstürzen, Dateibeschädigungen usw. gering ist.
  • Die absolut minimale Einrichtungszeit macht dies zu einem großartigen Start für Einzelentwickler oder kleine Teams (2-3 Personen).
  • Durch die Verwendung der Versionskontrolle werden Änderungen nachverfolgt, und häufig können Änderungen in der Dokumentation direkt mit einer Änderung des Codes verknüpft werden.
  • So einfach wie Text zu arbeiten, kann das Suchen, Bearbeiten usw. häufig mit Befehlszeilentools durchgeführt werden.

Nachteile:

  • Mehr als ein paar Benutzer und das Dokument würden leicht nicht mehr synchron sein.
  • Keine Links, daher verwenden Sie entweder ein grotesk großes Dokument oder mehrere kleinere, aber nicht verbundene Dokumente.
  • Eingeschränkte Formatierungs- und Veröffentlichungsoptionen (obwohl die Konvertierung, z. B. durch Markdown, einfach ist.)
  • So einfach wie Text zu arbeiten, so oft ist die Verwendung von Befehlszeilentools die einzige Möglichkeit, um zu suchen, die Bearbeitung zu erweitern usw.

Es ist nichts, worauf Sie sich bei jeder Art von Teamarbeit verlassen möchten, aber die Fähigkeit von Textdateien im Repo, damit Sie richtig arbeiten können, sollte für den einzelnen Entwickler nicht unterschätzt werden. Derzeit verwende ich ein Dokument als eine Art Übersichts- / Masterplaner, der das allgemeine Design enthält, ein zweites Dokument, das als ToDo-Liste spezifischer Dinge dient, die das Spiel benötigt, ein drittes Dokument als loser Bug-Tracker und Zusatzdokumente dazu Erarbeiten Sie nach Bedarf "Merkmal x".

CodexArcanum
quelle
2

Verwenden Sie kein Dokumentformat / -editor, der nicht für mehrere Benutzer geeignet ist (z. B. MS Word, Open Office Writer). Nur eine Person kann das Dokument bearbeiten, und selbst mit der Quellcodeverwaltung ist es zu einfach, mit der Arbeit an einer veralteten Version zu beginnen. Wenn Sie speichern, zerstören Sie im Grunde alles, was die anderen Benutzer seit der letzten Aktualisierung ihrer Version getan haben des Dokuments.

Freigegebene Ordner sind bei weitem die schlechteste Lösung und ein absolutes No-Go für jede Art von Asset, an dem gemeinsam gearbeitet werden soll. Sie können nie sicher sein, dass gerade jemand anderes an dieser Datei arbeitet oder dies in den nächsten Minuten tun wird. Sie haben auch keine Änderungsverfolgung und können im Katastrophenfall (menschliches Versagen oder menschliche Dummheit oder menschliche Vernachlässigung) nicht zu einer früheren Version zurückkehren.

Verwenden Sie vorzugsweise ein Wiki, das jedoch benutzerfreundlich und wirklich WYSIWYG ist. Ich persönlich schwöre bei Confluence , das auch in größeren Spieleentwicklungsstudios verwendet wird und nur 10 US-Dollar für bis zu 10 Benutzer und unbegrenzte Zuschauer kostet.

Die meisten anderen Wikis (MediaWiki, TikiWiki usw.) haben den Nachteil, dass sie eine steile Lernkurve haben oder für nicht technisches Personal sogar praktisch unbrauchbar sind. Nicht, dass sie es nicht lernen könnten, aber sie akzeptieren es (zu Recht) nicht, ein Dokumentensystem zu verwenden, bei dem Sie grundsätzlich Code wie HTML schreiben müssen. Dies ist mein Liebling: Wikis, die sagen, dass sie WYSIWYG sind, aber alles, was sie tun, ist, die Syntax in den Text einzufügen, den Sie schreiben. Das ist nicht WYSIWYG!

Die Richtlinie für die Verwendung eines Wikis besteht darin, jede Überschrift auf einer separaten Seite zu platzieren, damit Sie das Dokument in viele verwaltbare Teile schneiden können. Confluence bietet Funktionen, mit denen Sie alle diese Unterseiten wieder zu einer einzigen Site oder einem einzigen Dokument zusammenfassen können, das bzw. das beispielsweise als PDF exportiert werden kann.

LearnCocos2D
quelle
1

Ich denke, One Note ist eine gute Option. Es ist so etwas wie ein Wiki, aber mit viel Unterstützung für die Bearbeitung von Rich Text. Zusätzlich zum Standard-Desktop-Client, der mit Office geliefert wird, gibt es eine webbasierte Version mit der Office Live- Suite. Ehrlich gesagt denke ich, dass die kostenlose webbasierte Version für die meisten Anforderungen ausreichen sollte. In Kombination mit Skydrive haben Sie ein ziemlich gutes System, um an einem Live-Dokument zusammenzuarbeiten.

Alex Schearer
quelle
evernote.com ist auch eine Möglichkeit für Leute, die eine kostenlose Alternative zu OneNote suchen . Es verfügt über einen Webclient und Clients für verschiedene Plattformen (Desktops, Telefone) und speichert alle Ihre Notizen "in der Cloud". Ich denke, es hat auch Funktionen für die Zusammenarbeit, aber sie können Premium sein.
CodexArcanum
0

Für eines meiner Open-Source-Projekte haben wir SharePoint zum Speichern von Dokumenten und Medien verwendet. Das Verwalten von Benutzern und Berechtigungen ist recht unkompliziert und unterstützt den vollständigen Versionsverlauf. Wir haben die SharePoint-Website seit ungefähr vier Jahren, daher gibt es heutzutage möglicherweise bessere Optionen. Aber es hat sich ziemlich gut für uns gearbeitet. Es wird von einem Dritten gehostet (für ca. 20 USD / Monat), sodass nach der Ersteinrichtung praktisch keine Wartung von unserer Seite durchgeführt wurde. SharePoint unterstützt nicht nur Dokument- und Bildbibliotheken, sondern unterstützt auch Wiki, obwohl ich nicht sicher bin, wie gut es mit den populäreren Wiki-Engines mithalten kann.

Mike Strobel
quelle