Quel type de support / format utilisez-vous pour stocker et diffuser votre documentation de conception de jeu? Wiki? Fichiers doc? Fichiers dans le référentiel? Dossier partagé? Google Doc?
Veuillez indiquer les avantages et les inconvénients de chacun.
J'utilise Google Docs, car tout ce dont j'ai vraiment besoin, c'est d'un éditeur de texte en ligne. Je peux collaborer avec des personnes en ligne avec une relative facilité et je sais que mes informations y sont sécurisées en cas de panne de mon ordinateur.
Une autre option qui mérite d'être étudiée est d'utiliser Dropbox . Déposez un document Word dedans et vous obtenez instantanément un environnement collaboratif avec contrôle de version.
Wiki
Avantages:
Les inconvénients:
(* Nous avons utilisé un wiki pour un projet et les concepteurs ont toujours été tentés d'entrer et d '«améliorer» des parties de celui-ci, même sur des fonctionnalités qui avaient été approuvées et envoyées pour être codées. Puis, lorsque QA a commencé à tester la fonctionnalité, serait un cauchemar parce que souvent la conception suggérerait quelque chose de différent de ce qui a été réellement codé, et il faudrait un peu de travail frustrant pour savoir ce qui s'est passé en premier, le changement de conception ou de code.)
la source
Fichiers texte
Sur mon projet actuel, j'utilise des fichiers simples en texte brut dans mon dossier "Docs" du projet, stocké dans le référentiel à côté du code.
Avantages:
Les inconvénients:
Ce n'est pas quelque chose que vous souhaitez utiliser pour tout type de travail d'équipe, mais la puissance des fichiers texte dans le référentiel pour vous permettre de travailler correctement ne doit pas être sous-estimée pour le développeur unique. Actuellement, j'utilise un document comme une sorte de vue d'ensemble / maître-planificateur qui contient la conception générale, un deuxième document qui agit comme une liste de tâches spécifiques dont le jeu a besoin, un troisième document comme un suivi des bogues lâche et des documents auxiliaires pour élaborer sur "fonctionnalité x" au besoin.
la source
N'utilisez pas un format / éditeur de document qui n'est pas compatible avec plusieurs utilisateurs (par exemple MS Word, Open Office Writer). Une seule personne peut modifier le document, et même avec le contrôle de code source, il est trop facile de commencer à travailler sur une version obsolète, et en sauvegardant cela, vous détruisez essentiellement tout ce que les autres utilisateurs ont fait depuis la dernière fois que cet utilisateur a mis à jour sa version du document.
Les dossiers partagés sont de loin la pire solution et un refus absolu pour tout type d'actif censé être travaillé en collaboration. Vous ne pouvez jamais être sûr que quelqu'un d'autre travaille actuellement sur ce fichier, ou le fera dans les prochaines minutes. Vous n'avez pas non plus de suivi des modifications et ne pouvez pas revenir à une version précédente en cas de catastrophe (erreur humaine ou stupidité humaine ou négligence humaine).
Utilisez de préférence un Wiki, mais qui est convivial et est vraiment WYSIWYG. Personnellement, je jure par Confluence , , qui est également utilisé dans les plus grands studios de développement de jeux et ne coûte que 10 $ pour un maximum de 10 utilisateurs et des téléspectateurs illimités.
La plupart des autres wikis (MediaWiki, TikiWiki, etc.) ont l'inconvénient d'avoir une courbe d'apprentissage abrupte ou même d'être pratiquement inutilisables par du personnel non technique. Non pas qu'ils n'aient pas pu l'apprendre mais ils (à juste titre) n'acceptent pas d'utiliser un système de documents qui vous oblige essentiellement à écrire du code comme HTML. Voici ma bête noire: les wikis qui disent qu'ils sont WYSIWYG mais tout ce qu'ils font, c'est insérer la syntaxe dans le texte que vous écrivez. Ce n'est pas WYSIWYG!
La ligne directrice pour l'utilisation d'un wiki est de mettre chaque en-tête sur une page séparée, de sorte que vous pouvez couper le document en plusieurs parties gérables. Confluence offre des fonctionnalités avec lesquelles vous pouvez ensuite regrouper toutes ces sous-pages en un seul site ou document, qui peut être exporté au format PDF par exemple.
la source
Je pense que One Note est une bonne option. C'est quelque chose comme un wiki mais avec beaucoup de support d'édition de texte riche. En plus du client de bureau standard fourni avec Office, il existe une version Web avec la suite Office Live . Honnêtement, je pense que la version Web, qui est gratuite, devrait être suffisante pour la plupart des besoins et lorsqu'elle est combinée avec Skydrive, vous avez un assez bon système pour collaborer sur un document en direct.
la source
Pour l'un de mes projets open-source, nous avons utilisé (halètement) SharePoint pour stocker des documents et des médias. La gestion des utilisateurs et des autorisations est assez simple et prend en charge l'historique complet des versions. Nous avons le site SharePoint depuis environ quatre ans maintenant, il peut donc très bien y avoir de meilleures options de nos jours. Cependant, cela a plutôt bien fonctionné pour nous. Il est hébergé par un tiers (pour environ 20 $ / mois), donc après la configuration initiale, il n'y a eu pratiquement aucune maintenance de notre part. En plus de prendre en charge les bibliothèques de documents et d'images, SharePoint prend en charge Wiki, bien que je ne sois pas sûr de la mesure dans laquelle il se compare aux moteurs Wiki les plus populaires.
la source