Apa cara terbaik untuk menyimpan dokumentasi yang terkait dengan proyek kode?

Kami memiliki banyak dokumen yang terkait dengan pengembangan perangkat lunak kami. Ini termasuk hal-hal seperti persyaratan, dokumen desain, PDF eksternal, file pelanggan, instruksi pengujian, dll. Saat ini, dokumen-dokumen ini tersebar di semua tempat (wiki, "beberapa tempat di jaringan", hard drive pengembang lokal (!), dan bahkan tempat yang lebih buruk).

Apa cara terbaik untuk melacak mereka? Karena kami menggunakan visual studio (2010) untuk pengembangan kami, dan kami tidak benar-benar memiliki non-pengembang dalam proyek ini, saya pikir itu akan menjadi ide bagus untuk menyimpannya dalam "solusi" VS, yang akan memungkinkan mereka menjadi sumber yang dikendalikan, dan dapat diakses secara universal oleh semua pengembang.

Namun, VS benar-benar tampaknya tidak dibangun untuk melakukan ini. Jika Anda mengedit file dokumen apa pun, bahkan yang disiapkan dengan properti build "Tidak Ada", "Jangan salin", VS harus membangun kembali perangkat lunak sebelum akan berjalan kembali. Tidak ada cara untuk membuat "Proyek Dokumentasi" di dalam solusi. (Kami menggunakan proyek Empty C # untuk ini). Visual Studio dan Word / Excel flat tidak melakukan kontrol sumber dengan baik. Anda tidak dapat melihat file check-in, dan kemudian memutuskan untuk membuat perubahan tanpa terlebih dahulu menutup file, pergi ke proyek, dan memeriksa secara manual sebelum melakukan perubahan. Paling lambat dan membosankan.

Ngomong-ngomong, ini adalah yang terbaik yang dihasilkan oleh tim kami, tetapi saya benar-benar berharap saya memiliki solusi (gratis) yang lebih baik.

Saya tidak yakin apakah ada satu "cara terbaik", tetapi dari uraian Anda, sepertinya setiap pengembang melakukan sendiri cara menyimpan dokumentasi. Dapatkan dukungan dari semua orang dengan satu metode penyimpanan dokumentasi, dan akan jauh lebih mudah untuk mengaturnya.

Selain jawaban "temukan cara terbaik untuk Anda", saya katakan setidaknya untuk mencari solusi yang memudahkan Anda mencari dokumen . Di satu perusahaan, saya membuat wiki yang berisi tautan ke file yang dilemparkan ke serverland, yang tiba-tiba membuatnya lebih mudah untuk mencari dan menemukan dokumen di mana pun mereka berada. Setelah pengguna lain mulai menggunakan wiki untuk menemukan dokumen, mereka juga mulai memperbaharuinya untuk menautkan dokumen baru, atau hanya dengan membuat entri wiki sebagai dokumen.

Saya ingin mendengar dari orang lain jika mereka tahu tentang sistem kontrol versi gratis yang bekerja dengan baik dengan dokumen. Satu-satunya hal yang keluar dari kepala saya adalah Sharepoint, yang tidak sepenuhnya gratis. Saya telah melihat sistem versi tidak resmi di mana orang memiliki folder "Arsip", dan cukup meletakkan revisi file di folder itu, dengan revisi terbaru berada di tingkat folder yang sama dengan "Arsip".

Solusi yang paling berhasil di perusahaan saya adalah menyiapkan wiki (kami menggunakan mediawiki). Ini digunakan dalam banyak cara, dari entri wiki tradisional ke sederhana "Ini adalah ..." ditambah dokumen Word. Sangat mudah dicari. Kami secara bertahap membangun repositori informasi yang sangat berguna.

Setidaknya dalam VS 2008, Anda dapat mengatur tipe konfigurasi proyek C ++ (di bawah properti proyek-> general-> default proyek) ke Utilitas , dalam hal ini VS tidak melakukan apa-apa dengannya.

Sudahkah Anda mencoba menggunakan proyek semacam itu dalam solusi berbasis C #? (Mungkin proyek C # memiliki sesuatu yang serupa?)

Saya setuju bahwa tidak ada solusi terbaik di sini. Tetapi kontrol versi! = Termasuk dalam solusi; kebanyakan sistem dapat menangani hal-hal di luar IDE. Jadi seseorang dapat menjaga dokumen tetap dekat tetapi tidak dalam sebagian besar kasus.

Sekarang, melewati kebiasaan menjengkelkan kata untuk mengubah file setiap kali dibuka adalah masalah yang berbeda. . .

Tidak, proyek Visual Studio (well, C # dan Vb.net) memiliki pendekatan yang mematikan otak untuk solusi explorer. Yang VC ++ satu JAUH lebih baik karena Anda dapat membuat folder virtual yang tidak terikat dengan tata letak disk, dan meletakkan semua jenis barang di sana juga. Konyol Microsoft mematahkannya dengan mencoba membuatnya 'lebih mudah dimengerti'.

Anda masih bisa meletakkannya di 'folder solusi' tetapi masih tidak sefleksibel mungkin Anda inginkan. Itu berarti Anda harus menemukan alternatif dan alternatif yang saya rekomendasikan adalah alat web. Jika Anda tidak ingin mencoba portal proyek (seperti Redmine) di mana Anda dapat menyimpan dokumen dan memiliki wiki, pelacak bug, dll. Maka gunakan alat manajemen dokumen. Sesuatu seperti Nuxeo atau Owl akan membantu Anda. Setelah web, Anda memiliki lokasi pusat sehingga orang tahu di mana harus mencari hal-hal ini - itu mungkin bagian terpenting dari manajemen dokumen. Jika Anda mengikatnya ke sistem kontrol versi seperti subversi (teruskan, Anda tidak akan menyesal setelah VSS!) Maka Anda masih dapat menautkan dokumen ke alat web dan versi mengontrolnya juga.

Subversion bahkan memiliki kemampuan untuk mengekspos repositori sebagai folder webdav - yaitu folder jaringan - sehingga Anda dapat meletakkannya di 'drive jaringan' namun versi mereka masih dikontrol secara otomatis.

Saya masih memilih Redmine sebagai pilihan pribadi saya.