Hôm nay, một trong những đồng nghiệp của tôi và tôi có một cuộc tranh luận về "Chúng ta có nên đưa các tài liệu đặc tả vào hệ thống kiểm soát nguồn như SVN không?". Theo ý kiến của tôi, nó nên được. Mọi thứ liên quan đến phát triển dự án nên được kiểm soát cẩn thận với hệ thống kiểm soát nguồn. Có phải đó là một khái niệm sai trong quy trình phát triển phần mềm?
Câu trả lời:
Vậy điều gì sẽ xảy ra nếu hầu hết các hệ thống kiểm soát nguồn chỉ lưu trữ chúng dưới dạng các đốm màu? Hầu hết mọi người không cung cấp thông tin về sự khác biệt giữa các tài liệu, nhưng nếu có, bạn luôn có thể có hai phiên bản và sử dụng tính năng của hệ thống tác giả để tìm khác biệt.
Với dung lượng ổ cứng ở mức một xu mỗi gigabyte mỗi tháng, không có lý do chính đáng nào để không đưa tài liệu vào hệ thống kiểm soát nguồn và nó có thể hữu ích. Sở thích cá nhân của tôi là viết tài liệu bằng cách sử dụng đánh dấu nội tuyến, ví dụ Wiki Markup hoặc DocBook . Điều này cho phép sử dụng các công cụ mạnh mẽ để so sánh và sửa đổi tài liệu.
Phiên bản tài liệu đặc điểm kỹ thuật chắc chắn là một mục tiêu xứng đáng.
Tuy nhiên, các tài liệu đặc tả của bạn chỉ có văn bản và trong một tệp văn bản thuần túy ? Nếu vậy, đây có thể là một giải pháp tốt.
Nếu không, kiểm soát nguồn có lẽ không phải là nơi phù hợp với họ - kiểm soát nguồn có hại cho các tệp nhị phân .
Thông thường, các tệp văn bản đơn giản không tốt cho định dạng hoặc để xem nhanh, do đó, wiki với phiên bản có lẽ là một ý tưởng tốt hơn.
Tất cả các tài liệu nên ở một số dạng lưu trữ (tốt nhất là với các điều khiển sửa đổi).
Hệ thống kiểm soát nguồn là một giải pháp. Nhưng thông thường các hệ thống này được thiết kế cho các tài liệu văn bản đơn giản. Do đó, những thứ như tài liệu Word hoặc RTF, vv không phù hợp lắm (đặc biệt là khi bạn thử và so sánh các phiên bản khác nhau).
Nhưng có những giải pháp khác được thiết kế đặc biệt cho các tài liệu. SharePoint lò xo để tâm, nhưng tôi chắc chắn có những người khác.
Chắc chắn rồi. Vấn đề tài liệu được lưu trữ dưới dạng nhị phân (ví dụ tài liệu từ) gây khó chịu. Một cách giải quyết tốt là nếu bạn sử dụng một trong các công cụ Rùa (tôi đã thử SVN và Mercurial), bạn có thể chọn "Visual Diff" cho phép bạn chọn docdiff. Với docdiff bạn có thể thấy tất cả các thay đổi với màu sắc và công cụ :-). Nhược điểm chính là mỗi khi bạn thực hiện thay đổi, toàn bộ tài liệu lại được cam kết (không chỉ thay đổi). Nhưng xem xét rằng các tài liệu văn bản không lớn lắm và không gian đó có thể không phải là vấn đề chính của bạn, đây không phải là vấn đề.
Tôi chắc rằng bạn có thể sử dụng docdiff mà không cần Rùa, chỉ là tôi chưa thử nó.
Có một cách tiếp cận khác mà bạn nên thảo luận: BDD
Vui lòng xem xét Phát triển hướng hành vi với các thông số kỹ thuật thực thi. Thông số kỹ thuật của bạn được đơn giản hóa thành một loạt các câu lệnh Cho - Khi - Sau đó được lưu trữ trong các tệp văn bản. Một công cụ BDD như Cucumber hoặc SpecFlow chuyển đổi các tệp văn bản đó thành các thử nghiệm thực thi mà công cụ xây dựng của bạn có thể thực thi.
Dưa chuột: http://cukes.info/ - BDD cho Ruby
SpecFlow: http://www.specflow.org/ - BDD cho .Net
Để có bản giới thiệu nhanh về quy trình làm việc với một công cụ như SpecFlow, hãy xem qua phần giới thiệu về SpecFlow của Rob Conery: http://tekpub.com/view/con accept / 5
Giờ đây, không chỉ bạn đang phiên bản mã, mà cả thông số kỹ thuật và công cụ Tích hợp liên tục của bạn (nghĩ rằng TeamCity, CruiseControl, Hudson, v.v.) đang thực thi rằng tất cả các thông số kỹ thuật vẫn còn hiệu lực trên MỌI bản dựng ... Điều đó có giá trị với bạn không?