Kod projesiyle ilişkili belgeleri depolamanın en iyi yolu nedir?

Yazılım geliştirmemizle ilgili birçok belgemiz var. Bunlar, gereksinimler, tasarım belgeleri, harici PDF'ler, müşteri dosyaları, test talimatları vb. Gibi şeyleri içerir. Şu anda, bu belgeler yerel bir geliştiricinin sabit diski (!) ve daha da kötüsü).

Onları takip etmenin en iyi yolu nedir? Gelişimimiz için visual studio (2010) kullandığımız ve projede gerçekten geliştirici olmadığımız için onları VS "çözümü" içinde saklamanın harika bir fikir olacağını düşündüm. kaynak kontrollü ve tüm geliştiriciler tarafından evrensel olarak erişilebilir olması.

Ancak, VS gerçekten bunu yapmak için inşa edilmiş gibi görünmüyor. Herhangi bir belge dosyasını düzenlerseniz, "Hiçbiri", "Kopyalamayın" derleme özellikleriyle ayarlanmış olsa bile, VS yeniden çalışmaya başlamadan önce yazılımı yeniden oluşturmalıdır. Çözüm içinde bir "Dokümantasyon Projesi" oluşturmanın bir yolu yoktur. (Bunun için bir Boş C # projesi kullanıyoruz). Visual Studio ve Word / Excel flat, kaynak kontrolünü iyi yapmaz. Teslim edilen bir dosyayı görüntüleyemez ve ardından dosyayı kapatmadan, projeye gitmeden ve değişikliği yapmadan önce manuel olarak teslim etmeden değişiklik yapmaya karar veremezsiniz. En iyi ihtimalle yavaş ve sıkıcıdır.

Her neyse bu, ekibimizin ortaya çıkardığı en iyisi, ama keşke daha iyi (ücretsiz) bir çözümüm olsaydı.

Tek bir "en iyi yol" olup olmadığından emin değilim, ancak açıklamanızdan, her geliştiricinin kendi dokümanlarını saklama yolunu yaptığı gibi görünüyor. Dokümanları depolamak için tek bir yöntemle herkesin katılımını sağlayın ve düzenli tutmak çok daha kolay olacaktır.

"Sizin için en iyi yolu bul" yanıtının yanı sıra, en azından belge aramayı kolaylaştıran bir çözüm aramayı da söyleyebilirim . Bir şirkette, sunucu alanı hakkında atılan dosyalara bağlantılar içeren bir wiki oluşturdum, bu da nerede olursa olsun belgeleri aramayı ve bulmayı çok daha kolay hale getirdi. Diğer kullanıcılar belgeleri bulmak için wiki'yi kullanmaya başladığında, yeni belgeleri bağlamak için ya da yalnızca belge olarak bir wiki girişi oluşturarak onu güncellemeye başladılar.

Belgelerle iyi çalışan ücretsiz sürüm kontrol sistemlerini biliyorlarsa başkalarından duymak isterim. Başımın tepesinden çıkan tek şey, tam olarak özgür olmayan Sharepoint. Ben insanların bir "Arşiv" klasörü var gayri resmi versiyonlama sistemleri gördüm ve sadece bu klasörde bir dosya revizyonlar koymak, en yeni revizyon "Arşiv" ile aynı klasör düzeyinde olmak.

Şirketimde en iyi sonucu veren çözüm bir wiki kurmaktı (mediawiki kullanıyoruz). Geleneksel wiki girişlerinden basit bir "Bu bir ..." artı bir Word belgesine kadar birçok şekilde kullanılır. Aramak çok kolay. Yavaş yavaş çok faydalı bir bilgi havuzu oluşturuyoruz.

En azından VS 2008'de, Yardımcı Program için bir C ++ projesinin yapılandırma türünü (proje özellikleri-> genel-> proje varsayılanları altında) ayarlayabilirsiniz , bu durumda VS onunla hiçbir şey yapmaz.

C # tabanlı çözümünüzde böyle bir projeyi kullanmaya çalıştınız mı? (Belki bir C # projesinde benzer bir şey vardır?)

Kesinlikle burada en iyi çözüm olmadığını kabul ediyorum. Ancak sürüm kontrolü! = Çözüme dahil edilmiştir; çoğu sistem IDE'nin ötesindeki şeylerle başa çıkabilir. Yani çoğu durumda belgeleri yakın ama notta tutabilirsiniz.

Şimdi, dosyaları her açıldığında değiştirmek için can sıkıcı kelime alışkanlıklarını geçmiş farklı bir sorundur. . .

Hayır, Visual Studio (iyi, C # ve Vb.net) projelerinin çözüm gezgini için beyni ölü bir yaklaşımı var. VC ++ one, disk düzenine bağlı olmayan sanal klasörler oluşturabileceğiniz ve her türlü şeyi oraya koyabileceğiniz için çok daha iyidir. Aptal Microsoft, 'anlamayı daha kolay' hale getirmeye çalışarak kırdı.

Yine de bir 'çözüm klasörüne' koyabilirsiniz, ancak yine de muhtemelen istediğiniz kadar esnek değil. Bu, bir alternatif bulmanız gerektiği anlamına gelir ve önerilen alternatiflerim web araçlarıdır. Belgeleri depolayabileceğiniz ve wiki, hata izleyici vb. Alabileceğiniz bir proje portalı (Redmine gibi) denemek istemiyorsanız , belge yönetim aracına gidin. Nuxeo veya Owl gibi bir şey seni iyi yapar. Bir kez web, merkezi bir konuma sahip böylece insanlar nerede bu tür şeyler aramak için bilmek - bu muhtemelen belge yönetiminin en önemli parçası. Eğer subversion gibi bir sürüm kontrol sistemine bağlarsanız (devam edin, VSS'den sonra pişman olmayacaksınız!) O zaman belgeleri web araçlarına bağlayabileceksiniz ve sürümleri de kontrol edebileceksiniz.

Subversion, depoyu webdav klasörü - yani bir ağ klasörü - olarak açığa çıkarabilir, böylece onları bir 'ağ sürücüsüne' koyabilirsiniz, ancak yine de otomatik olarak sürümleri kontrol ettirebilirsiniz.

Kişisel tercihim olarak hala Redmine'i tercih ederdim.