Sử dụng Cucumber hoặc RSpec + Selenium để tạo tài liệu người dùng cuối?

Question

Có ai đã cố gắng tạo tài liệu/tài liệu hướng dẫn người dùng cuối (có khả năng trực tuyến, có khả năng được in) ra khỏi các tình huống dưa chuột của bạn không? Hoặc chụp ảnh màn hình để sử dụng trong tài liệu sử dụng RSpec và khả năng của Selenium RC để làm như vậy?

Đối với dưa chuột, tôi tưởng tượng cái gì đó như:

Scenario: If you want to add a link 
Given I am on the edit blog post page 
When I press the "add link" button 
And I type in a link URL "http://stackoverflow.com" 
And I click "OK" 
Then the blog post should have 1 link 

Dịch tài liệu:

Nếu bạn muốn thêm một liên kết, đi đến trang chỉnh sửa bài đăng blog. Nhấn nút "thêm liên kết" và nhập URL, như "http://stackoverflow.com", vào trường URL liên kết . Nhấp "OK".

Bạn có nên dành thời gian để thử và viết một cái gì đó để phân tích tính năng Dưa chuột của tôi thành tài liệu và hai, để viết/cấu trúc các tính năng Dưa chuột của tôi theo cách tạo tài liệu hay không? Liệu tài liệu kết quả có kết thúc thực sự nhàm chán mà không có nhiều biến đổi trong cấu trúc?

Có điều gì khác ngoài ý tưởng này không? Doxygen có vẻ như đó là nhiều tài liệu mã hơn tài liệu người dùng cuối.

Điều gì sẽ tự động chụp ảnh màn hình? Điều này có vẻ giống như một con đường hiệu quả hơn-- chỉ cần sử dụng lại mã có ảnh chụp màn hình khi kiểm tra RSpec không thành công và để nó mất một trong các tình huống được quy định. Có cách nào tốt hơn để làm điều này?

Answer 1

Bạn nên xem đá quý cucumber-screenshot. Dường như nó thực hiện chính xác những gì bạn muốn - lấy HTML hoặc (nếu bạn đang sử dụng máy Mac) ảnh chụp màn hình PNG của mỗi bước trong kịch bản của bạn. (Tôi đã chơi với my own version of this idea trong một thời gian năm ngoái. Tôi đã bỏ nó khá sớm, vì vậy bạn có thể tốt hơn với dưa chuột-ảnh chụp màn hình, nhưng cảm thấy tự do để có bất cứ điều gì bạn có thể sử dụng từ Visible Cukes quá).

Answer 2

Âm thanh tuyệt vời. Có lẽ bạn không muốn một số kịch bản dưa chuột có sẵn cho toàn thế giới. Nếu một nhà phát triển đặt một cái gì đó nhạy cảm, như tên người/mật khẩu phát triển; hoặc một trang web khai thác đã được phát hiện và một kịch bản dưa chuột đã được viết để xác minh nó đã được vá.

Answer 3

Tôi sử dụng Lowdown (http://lowdownapp.com) để liên lạc các tính năng qua lại với khách hàng. Toàn bộ điểm dưa chuột là nó là doanh nghiệp cụ thể, vì vậy bạn không cần phải dịch nó sang định dạng khác cho tài liệu. Tôi thấy bạn đang đi đâu.

Bạn có thể sử dụng http://seleniumshots.com/ để nhận ảnh chụp màn hình từ ứng dụng của mình từ các thử nghiệm. Tôi không biết nếu nó ra khỏi phiên bản beta được nêu ra, mặc dù.