Quelle est la meilleure façon de stocker la documentation associée à un projet de code?

Nous avons beaucoup de documents associés à notre développement logiciel. Celles-ci incluent des choses comme les exigences, les documents de conception, les PDF externes, les fichiers clients, les instructions de test, etc. Actuellement, ces documents sont dispersés partout (wiki, "un endroit sur le réseau", un disque dur de développeur local (!), et pire encore).

Quelle est la meilleure façon de les suivre? Puisque nous utilisons Visual Studio (2010) pour notre développement, et que nous n'avons pas vraiment de non-développeurs sur le projet, j'ai pensé que ce serait une bonne idée de les stocker dans la "solution" VS, ce qui leur permettrait être contrôlé par la source et accessible à tous par tous les développeurs.

Cependant, VS ne semble vraiment pas être conçu pour cela. Si vous modifiez un fichier de document, même celui qui est configuré avec les propriétés de construction "None", "Do not copy", VS doit reconstruire le logiciel avant de le réexécuter. Il n'y a aucun moyen de créer un "projet de documentation" dans la solution. (Nous utilisons pour cela un projet C # vide). Visual Studio et Word / Excel flat ne font pas bien le contrôle de code source. Vous ne pouvez pas afficher un fichier archivé, puis décider d'apporter une modification sans d'abord fermer le fichier, accéder au projet et l'extraire manuellement avant d'effectuer la modification. C'est lent et fastidieux au mieux.

Quoi qu'il en soit, c'est le meilleur que notre équipe ait trouvé, mais j'aimerais vraiment avoir une meilleure solution (gratuite).

Je ne sais pas s'il existe une seule "meilleure façon", mais d'après votre description, il semble que chaque développeur fasse sa propre façon de stocker la documentation. Obtenez l'adhésion de tout le monde sur une seule méthode de stockage de la documentation, et il sera beaucoup plus facile de la garder organisée.

Outre la réponse «trouver la meilleure façon pour vous», je dirais au moins de rechercher une solution qui facilite la recherche de documents . Dans une entreprise, j'ai créé un wiki qui contenait des liens vers des fichiers jetés sur serverland, ce qui a soudainement rendu beaucoup plus facile la recherche et la localisation de documents, où qu'ils se trouvent. Une fois que d'autres utilisateurs ont commencé à utiliser le wiki pour rechercher des documents, ils ont également commencé à le mettre à jour pour lier de nouveaux documents ou simplement en créant une entrée wiki en tant que document.

J'aimerais entendre quelqu'un d'autre s'il connaît les systèmes de contrôle de version gratuits qui fonctionnent bien avec les documents. La seule chose qui me vient à l'esprit est Sharepoint, qui n'est pas exactement gratuit. J'ai vu des systèmes de version non officiels où les gens ont un dossier "Archive", et mettent simplement les révisions passées d'un fichier dans ce dossier, la dernière révision étant au même niveau de dossier que "Archive".

La solution qui a fonctionné le mieux dans mon entreprise était de créer un wiki (nous utilisons mediawiki). Il est utilisé de nombreuses façons, des entrées wiki traditionnelles au simple "Ceci est un ..." en plus d'un document Word. Il est très facile de rechercher. Nous construisons progressivement un référentiel d'informations très utile.

Dans VS 2008 au moins, vous pouvez définir le type de configuration d' un projet C ++ (sous propriétés du projet -> général -> valeurs par défaut du projet) sur Utilitaire , auquel cas VS ne fait rien avec.

Avez-vous essayé d'utiliser un tel projet dans votre solution basée sur C #? (Peut-être qu'un projet C # a quelque chose de similaire?)

Je suis définitivement d'accord qu'il n'y a pas de solution optimale ici. Mais contrôle de version! = Inclus dans la solution; la plupart des systèmes peuvent gérer des choses au-delà de l'IDE. On peut donc garder les documents à proximité mais pas à l'intérieur dans la plupart des cas.

Maintenant, surmonter les habitudes ennuyeuses de Word pour changer les fichiers chaque fois qu'ils sont ouverts est un problème différent. . .

Non, les projets Visual Studio (enfin, C # et Vb.net) ont une approche cérébrale de l'explorateur de solutions. Celui de VC ++ est BEAUCOUP mieux car vous pouvez créer des dossiers virtuels qui ne sont pas liés à la disposition du disque et y mettre toutes sortes de choses. Silly Microsoft l'a cassé en essayant de le rendre «plus facile à comprendre».

Vous pouvez toujours le mettre dans un «dossier de solution» mais ce n'est toujours pas aussi flexible que vous le voudrez probablement. Cela signifie que vous devez trouver une alternative et mes alternatives recommandées sont des outils Web. Si vous ne voulez pas essayer un portail de projet (comme Redmine) où vous pouvez stocker des documents et avoir un wiki, un traqueur de bogues, etc., optez pour un outil de gestion de documents. Quelque chose comme Nuxeo ou Owl vous ferait du bien. Une fois que c'est le Web, vous avez un emplacement central pour que les gens sachent où chercher ces choses - c'est probablement la partie la plus importante de la gestion des documents. Si vous le liez à un système de contrôle de version comme subversion (continuez, vous ne le regretterez pas après VSS!), Vous pourrez toujours lier les documents aux outils Web et les contrôler également.

Subversion a même la possibilité d'exposer le référentiel en tant que dossier webdav - c'est-à-dire un dossier réseau - afin que vous puissiez les placer sur un «lecteur réseau» tout en les contrôlant automatiquement.

Je choisirais toujours Redmine comme préférence personnelle.