2010-05-05 12 views
10

Hat jemand versucht, aus Ihren Gurkenszenarien Endbenutzer (möglicherweise online, möglicherweise gedruckte) Hilfe/Dokumentation zu erstellen? Oder Screenshots für den Einsatz in der Dokumentation mit der Fähigkeit von RSpec und Selenium RC gemacht?Mit Gurke oder RSpec + Selenium Endbenutzerdokumentation erstellen?

Für Gurken, ich stelle mir vor, so etwas wie:

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 

in der Dokumentation zu übersetzen:

Wenn Sie einen Link hinzufügen möchten, gehen Sie zu dem Blog-Post Seite bearbeiten. Klicken Sie auf die Schaltfläche "add link" und geben Sie eine URL wie "http://stackoverflow.com" in das Feld URL der URL ein. OK klicken".

Wäre es meine Zeit wert sein, um zu versuchen und, für ein, schreiben Sie etwas meine Gurke Funktionen in der Dokumentation zu analysieren, und zwei, zu schreiben/Struktur meine Gurke Funktionen in einer solchen Art und Weise, wie eine gute Dokumentation zu erstellen? Würde die resultierende Dokumentation am Ende wirklich langweilig ohne viel Variation in der Struktur klingen?

Gibt es sonst noch etwas wie diese Idee? Doxygen sieht so aus, als ob es mehr für Code-Dokumentation als Endbenutzer-Dokumentation ist.

Was ist mit automatischen Screenshots? Dies scheint ein ertragreicherer Weg zu sein - verwenden Sie einfach den Code, der einen Screenshot erstellt, wenn ein RSpec-Test fehlschlägt, und nehmen Sie einen in vorgeschriebenen Situationen. Gibt es einen besseren Weg, dies zu tun?

Antwort

3

Sie sollten einen Blick auf das cucumber-screenshot Juwel werfen. Es sieht so aus, als ob es genau das tut, was Sie wollen - HTML oder (wenn Sie auf einem Mac sind) PNG Screenshots von jedem Schritt in Ihren Szenarien. (Ich habe letztes Jahr eine Weile mit my own version of this idea gespielt. Ich habe es ziemlich früh fallen gelassen, also bist du wahrscheinlich besser dran mit gurke-screenshot, aber kannst du auch alles nehmen, was du von Visible Cukes verwenden kannst).

0

Klingt cool. Vielleicht möchten Sie nicht, dass einige der Gurkenszenarien für die ganze Welt verfügbar sind. Wenn ein Entwickler etwas Sensitives, wie die Namen/Entwicklungskennwörter der Leute, anlegt; oder ein Website-Exploit wurde entdeckt und ein Gurken-Szenario wurde geschrieben, um zu verifizieren, dass es gepatcht wurde.

3

Ich verwende Lowdown (http://lowdownapp.com), um Funktionen mit Clients zu kommunizieren. Der springende Punkt von Gurke ist, dass es geschäftsspezifisch ist, also sollten Sie es nicht in ein anderes Dokumentationsformat übersetzen müssen. Ich sehe allerdings, wohin du gehst.

Sie können http://seleniumshots.com/ verwenden, um Screenshots von Ihrer App aus den Tests zu erhalten. Ich weiß nicht, ob es noch nicht in der Betaversion ist.