Wie kann die mit einem Codeprojekt verknüpfte Dokumentation am besten gespeichert werden?

Wir haben viele Dokumente im Zusammenhang mit unserer Softwareentwicklung. Dazu gehören Anforderungen, Designdokumente, externe PDFs, Kundendateien, Testanweisungen usw. Derzeit sind diese Dokumente über den gesamten Ort verteilt (Wiki, "irgendwo im Netzwerk", eine lokale Entwicklerfestplatte (!)). und noch schlimmere Orte).

Was ist der beste Weg, um sie im Auge zu behalten? Da wir Visual Studio (2010) für unsere Entwicklung verwenden und wir keine Nicht-Entwickler im Projekt haben, hielt ich es für eine großartige Idee, sie in der VS- "Lösung" zu speichern, die es ihnen ermöglichen würde Quellcodegesteuert und für alle Entwickler universell zugänglich.

VS scheint jedoch nicht wirklich dafür gebaut zu sein. Wenn Sie eine Dokumentdatei bearbeiten, auch eine, die mit den Build-Eigenschaften "Keine", "Nicht kopieren" eingerichtet wurde, muss VS die Software neu erstellen, bevor sie erneut ausgeführt wird. Es gibt keine Möglichkeit, ein "Dokumentationsprojekt" innerhalb der Lösung zu erstellen. (Wir verwenden hierfür ein leeres C # -Projekt). Visual Studio und Word / Excel Flat steuern die Quellcodeverwaltung nicht gut. Sie können eine eingecheckte Datei nicht anzeigen und dann eine Änderung vornehmen, ohne zuerst die Datei zu schließen, zum Projekt zu wechseln und sie manuell auszuchecken, bevor Sie die Änderung vornehmen. Es ist bestenfalls langsam und langweilig.

Auf jeden Fall ist dies das Beste, was unser Team sich ausgedacht hat, aber ich wünschte wirklich, ich hätte eine bessere (kostenlose) Lösung.

Ich bin mir nicht sicher, ob es einen einzigen "besten Weg" gibt, aber Ihrer Beschreibung nach klingt es so, als würde jeder Entwickler seine eigene Art der Dokumentation speichern. Holen Sie sich ein Buy-In von allen für eine einzige Methode zum Speichern von Dokumentation, und es wird viel einfacher sein, sie organisiert zu halten.

Neben der Antwort "Finde den besten Weg für dich" würde ich sagen, zumindest nach einer Lösung zu suchen, die die Suche nach Dokumenten erleichtert . In einer Firma habe ich ein Wiki eingerichtet, das Links zu Dateien enthält, die rund um Serverland abgelegt wurden. Dadurch war es plötzlich viel einfacher, Dokumente zu suchen und zu finden, unabhängig davon, wo sie sich befanden. Sobald andere Benutzer das Wiki zum Suchen von Dokumenten verwendet haben, haben sie auch damit begonnen, es zu aktualisieren, um entweder neue Dokumente zu verknüpfen, oder indem sie einfach einen Wiki-Eintrag als Dokument erstellt haben.

Ich würde gerne von anderen hören, wenn sie über kostenlose Versionskontrollsysteme Bescheid wissen, die gut mit Dokumenten funktionieren. Das einzige, was mir auf den Kopf kommt, ist Sharepoint, das nicht gerade kostenlos ist. Ich habe inoffizielle Versionsverwaltungssysteme gesehen, bei denen Benutzer einen "Archiv" -Ordner haben und einfach frühere Revisionen einer Datei in diesen Ordner gelegt haben, wobei sich die neueste Revision auf derselben Ordnerebene wie "Archiv" befindet.

Die Lösung, die in meinem Unternehmen am besten funktioniert hat, war die Einrichtung eines Wikis (wir verwenden MediaWiki). Es wird auf vielfältige Weise verwendet, von den traditionellen Wiki-Einträgen bis hin zu einem einfachen "Dies ist ein ..." und einem Word-Dokument. Es ist sehr einfach zu suchen. Wir bauen nach und nach ein sehr nützliches Informationsarchiv auf.

Zumindest in VS 2008 können Sie den Konfigurationstyp eines C ++ - Projekts (unter Projekteigenschaften-> Allgemein-> Projekteinstellungen) auf Dienstprogramm setzen . In diesem Fall macht VS nichts damit.

Haben Sie versucht, ein solches Projekt in Ihrer C # -basierten Lösung zu verwenden? (Vielleicht hat ein C # -Projekt etwas Ähnliches?)

Ich stimme definitiv zu, dass es hier keine beste Lösung gibt. Aber Versionskontrolle! = In Lösung enthalten; Die meisten Systeme können Dinge jenseits der IDE verarbeiten. So kann man die Dokumente in den meisten Fällen in der Nähe halten, aber nicht innerhalb.

Jetzt ist es ein anderes Problem, lästige Wortgewohnheiten zu überwinden, um Dateien beim Öffnen zu ändern. . .

Nein, Visual Studio-Projekte (naja, C # und Vb.net) haben einen hirntoten Ansatz für den Lösungs-Explorer. Das VC ++ ist VIEL besser, da Sie virtuelle Ordner erstellen können, die nicht an das Festplattenlayout gebunden sind, und dort auch alle möglichen Dinge ablegen können. Dumme Microsoft hat es gebrochen, indem sie versucht hat, es "verständlicher" zu machen.

Sie können es immer noch in einen "Lösungsordner" legen, aber es ist immer noch nicht so flexibel, wie Sie es wahrscheinlich wollen. Das heißt, Sie müssen eine Alternative finden, und meine empfohlenen Alternativen sind Web-Tools. Wenn Sie kein Projektportal (wie Redmine) ausprobieren möchten, in dem Sie Dokumente speichern und über ein Wiki, einen Bug-Tracker usw. verfügen können, wählen Sie ein Dokumentverwaltungstool. So etwas wie Nuxeo oder Owl würde dir gut tun. Sobald es sich um das Web handelt, haben Sie einen zentralen Ort, an dem die Leute wissen, wo sie nach diesen Dingen suchen müssen - das ist wahrscheinlich der wichtigste Teil des Dokumentenmanagements. Wenn Sie es an ein Versionskontrollsystem wie Subversion binden (fahren Sie fort, Sie werden es nach VSS nicht bereuen!), Können Sie die Dokumente weiterhin mit den Web-Tools verknüpfen und auch die Versionskontrolle durchführen.

Subversion bietet sogar die Möglichkeit, das Repository als Webdav-Ordner (dh als Netzwerkordner) verfügbar zu machen, sodass Sie sie auf einem "Netzwerklaufwerk" ablegen und die Version dennoch automatisch versionieren können.

Ich würde immer noch Redmine als meine persönliche Präferenz wählen.