Utilizzo di Cucumber o RSpec + Selenium per creare la documentazione per l'utente finale?

Question

Qualcuno ha provato a creare aiuto/documentazione da parte dell'utente finale (potenzialmente online, potenzialmente da stampare) dagli scenari di cetriolo? O preso screenshot per l'uso nella documentazione utilizzando RSpec e la capacità di Selenium RC di farlo?

Per cetriolo, che sto immaginando qualcosa di simile:

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 

Tradurre la documentazione:

Se si desidera aggiungere un link, vai alla pagina di modifica post del blog. Premere il pulsante "aggiungi link" e digitare un URL, come "http://stackoverflow.com", nel campo URL di collegamento . Fai clic su "OK".

sarebbe la pena il mio tempo per cercare di, per esempio, scrivere qualcosa per analizzare le mie caratteristiche di cetriolo nella documentazione, e due, di scrivere/struttura mie caratteristiche cetriolo in modo tale da creare una buona documentazione? La documentazione risultante finirà per sembrare davvero noiosa senza molte variazioni nella struttura?

C'è qualcos'altro là fuori come questa idea? Doxygen sembra che sia più per la documentazione del codice che per la documentazione per l'utente finale.

Che ne dici di acquisire automaticamente gli screenshot? Questo sembra un percorso più fruttuoso - basta riutilizzare il codice che cattura uno screenshot quando un test RSpec fallisce e farlo prendere in situazioni prescritte. C'è un modo migliore per farlo?

Answer 1

Dovresti dare un'occhiata alla gemma cucumber-screenshot. Sembra che faccia esattamente quello che vuoi: prendere screenshot in formato HTML o (se sei su Mac) di ogni fase dei tuoi scenari. (Stavo giocando con lo my own version of this idea per un po 'l'anno scorso, l'ho lasciato abbastanza presto, quindi probabilmente stai meglio con lo screenshot di cetriolo, ma sentiti libero di prendere qualsiasi cosa tu possa usare anche da Visible Cukes).

Answer 2

Suoni fantastici. Forse non vuoi alcuni degli scenari di cetriolo disponibili per il mondo intero. Se uno sviluppatore mette qualcosa di sensibile, come nomi di persone/password di sviluppo; o è stato scoperto un exploit di un sito Web e è stato scritto uno scenario di cetriolo per verificare che sia stato corretto.

Answer 3

Io uso Lowdown (http://lowdownapp.com) per comunicare le funzioni avanti e indietro con i client. L'intero punto di cetriolo è che è specifico del business, quindi non dovresti tradurlo in un altro formato per la documentazione. Però vedo un po 'dove stai andando.

È possibile utilizzare http://seleniumshots.com/ per ottenere screenshot dall'app dai test. Non so se è ancora fuori dalla beta, però.