Cách tốt nhất để lưu trữ tài liệu liên quan đến một dự án mã là gì?

Chúng tôi có rất nhiều tài liệu liên quan đến phát triển phần mềm của chúng tôi. Chúng bao gồm những thứ như yêu cầu, tài liệu thiết kế, tệp PDF bên ngoài, tệp khách hàng, hướng dẫn kiểm tra, v.v. Hiện tại, các tài liệu này nằm rải rác khắp nơi (wiki, "một số nơi trên mạng", ổ cứng của nhà phát triển địa phương (!), và thậm chí những nơi tồi tệ hơn).

Cách tốt nhất để theo dõi chúng là gì? Vì chúng tôi sử dụng visual studio (2010) cho sự phát triển của chúng tôi và chúng tôi thực sự không có bất kỳ nhà phát triển nào trong dự án, tôi nghĩ rằng sẽ là một ý tưởng tuyệt vời để lưu trữ chúng trong "giải pháp" VS, cho phép họ được kiểm soát nguồn và có thể truy cập toàn cầu bởi tất cả các nhà phát triển.

Tuy nhiên, VS thực sự dường như không được xây dựng để làm điều này. Nếu bạn chỉnh sửa bất kỳ tệp tài liệu nào, ngay cả một tệp được thiết lập với thuộc tính bản dựng "Không", "Không sao chép", VS sẽ phải xây dựng lại phần mềm trước khi nó chạy lại. Không có cách nào để tạo một "Dự án Tài liệu" trong giải pháp. (Chúng tôi sử dụng một dự án C # rỗng cho việc này). Visual Studio và Word / Excel phẳng không kiểm soát nguồn tốt. Bạn không thể xem tệp đã đăng ký và sau đó quyết định thực hiện thay đổi mà không đóng tệp trước, đi đến dự án và kiểm tra thủ công trước khi thực hiện thay đổi. Nó chậm và tẻ nhạt nhất.

Dù sao đây là điều tốt nhất mà nhóm chúng tôi đã đưa ra, nhưng tôi thực sự ước mình có giải pháp tốt hơn (miễn phí).

Tôi không chắc chắn nếu có một "cách tốt nhất" duy nhất, nhưng từ mô tả của bạn, có vẻ như mọi nhà phát triển đang thực hiện cách lưu trữ tài liệu của riêng họ. Nhận mua từ mọi người trên một phương pháp lưu trữ tài liệu duy nhất và việc tổ chức tài liệu sẽ dễ dàng hơn rất nhiều.

Bên cạnh câu trả lời "tìm cách tốt nhất cho bạn", tôi sẽ nói ít nhất là tìm kiếm một giải pháp giúp bạn dễ dàng tìm kiếm tài liệu . Tại một công ty, tôi đã thiết lập một wiki chứa các liên kết đến các tập tin được gửi về serverland, điều này đột nhiên giúp việc tìm kiếm và định vị tài liệu dễ dàng hơn bất kể chúng ở đâu. Khi những người dùng khác bắt đầu sử dụng wiki để tìm tài liệu, họ cũng bắt đầu cập nhật nó để liên kết các tài liệu mới hoặc chỉ bằng cách tạo một mục wiki làm tài liệu.

Tôi rất muốn nghe từ bất cứ ai khác nếu họ biết về các hệ thống kiểm soát phiên bản miễn phí hoạt động tốt với các tài liệu. Thứ duy nhất bật ra khỏi đầu tôi là Sharepoint, thứ không chính xác. Tôi đã thấy các hệ thống phiên bản không chính thức nơi mọi người có thư mục "Lưu trữ" và chỉ cần đặt các bản sửa đổi của tệp trong thư mục đó, với phiên bản mới nhất ở cùng cấp thư mục với "Lưu trữ".

Giải pháp hiệu quả nhất ở công ty tôi là thiết lập wiki (chúng tôi sử dụng mediawiki). Nó được sử dụng theo nhiều cách, từ các mục wiki truyền thống đến một "Đây là một ..." đơn giản cộng với một tài liệu Word. Nó rất dễ dàng để tìm kiếm. Chúng tôi đang dần xây dựng một kho thông tin rất hữu ích.

Ít nhất trong VS 2008, bạn có thể đặt loại cấu hình của dự án C ++ (theo thuộc tính dự án-> chung-> mặc định của dự án) thành Tiện ích , trong trường hợp đó VS không làm gì với nó.

Bạn đã thử sử dụng một dự án như vậy trong giải pháp dựa trên C # của mình chưa? (Có lẽ một dự án C # có gì đó tương tự?)

Tôi chắc chắn đồng ý rằng không có một giải pháp tốt nhất nào ở đây. Nhưng kiểm soát phiên bản! = Bao gồm trong giải pháp; hầu hết các hệ thống có thể xử lý những thứ ngoài IDE. Vì vậy, người ta có thể giữ các tài liệu gần nhưng nota trong hầu hết các trường hợp.

Bây giờ, vượt qua thói quen khó chịu của từ để thay đổi tập tin bất cứ khi nào chúng được mở là một vấn đề khác. . .

Không, các dự án Visual Studio (tốt, C # và Vb.net) có cách tiếp cận não bộ đối với nhà thám hiểm giải pháp. Phiên bản VC ++ tốt hơn nhiều vì bạn có thể tạo các thư mục ảo không bị ràng buộc với bố cục đĩa và cũng đặt tất cả các loại nội dung vào đó. Microsoft ngớ ngẩn đã phá vỡ nó bằng cách cố gắng làm cho nó 'dễ hiểu hơn'.

Bạn vẫn có thể đặt nó trong 'thư mục giải pháp' nhưng nó vẫn không linh hoạt như bạn có thể muốn. Điều đó có nghĩa là bạn phải tìm một giải pháp thay thế và các phương án được đề nghị của tôi là các công cụ web. Nếu bạn không muốn thử một cổng thông tin dự án (chẳng hạn như Redmine), nơi bạn có thể lưu trữ tài liệu và có wiki, trình theo dõi lỗi, v.v. thì hãy tìm một công cụ quản lý tài liệu. Một cái gì đó như Nuxeo hoặc Owl sẽ làm tốt cho bạn. Khi có một trang web, bạn có một vị trí trung tâm để mọi người biết nơi tìm những thứ này - đó có lẽ là phần quan trọng nhất của quản lý tài liệu. Nếu bạn buộc nó vào một hệ thống kiểm soát phiên bản như lật đổ (tiếp tục, bạn sẽ không hối tiếc sau VSS!) Thì bạn vẫn có thể liên kết các tài liệu với các công cụ web và phiên bản cũng kiểm soát chúng.

Subversion thậm chí có khả năng hiển thị kho lưu trữ dưới dạng thư mục webdav - tức là thư mục mạng - vì vậy youcoudl đặt chúng vào 'ổ đĩa mạng' nhưng vẫn có phiên bản được điều khiển tự động.

Tôi vẫn sẽ chọn Redmine theo sở thích cá nhân của mình.