2010-05-05 12 views
10

¿Alguien ha intentado crear la ayuda/documentación del usuario final (potencialmente en línea, potencialmente a ser impreso) fuera de los escenarios de su pepino? ¿O capturas de pantalla tomadas para usar en documentación usando RSpec y la habilidad de Selenium RC para hacerlo?¿Cómo usar Cucumber o RSpec + Selenium para crear la documentación del usuario final?

Para pepino, yo estoy imaginando algo como:

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 

La traducción de la documentación:

Si desea agregar un enlace, ir a la página de edición entrada en el blog. Presione el botón "agregar enlace" y escriba una URL, como "http://stackoverflow.com", en el campo de URL del enlace . Haga clic en Aceptar".

valdría la pena mi tiempo para tratar de, por ejemplo, escribir algo para analizar mis características pepino en la documentación, y dos, para escribir/estructura de mis características pepino de tal manera como para crear una buena documentación? ¿La documentación resultante terminaría sonando realmente aburrida sin mucha variación en la estructura?

¿Hay algo más como esta idea? Doxygen parece que es más para la documentación del código que para la documentación del usuario final.

¿Qué hay de tomar capturas de pantalla automáticamente? Esto parece una ruta más fructífera: solo reutilice el código que toma una captura de pantalla cuando falla una prueba RSpec y haga que tome una en situaciones prescritas. ¿Hay una mejor manera de hacer esto?

Respuesta

3

Debería echar un vistazo a la gema cucumber-screenshot. Parece que hace exactamente lo que quiere, tomando HTML o (si está en una Mac) capturas de pantalla PNG de cada paso en sus escenarios. (Estuve jugando con my own version of this idea durante un tiempo el año pasado. Lo dejé caer desde el principio, por lo que probablemente estés mejor con la captura de pantalla de pepino, pero puedes tomar cualquier cosa que puedas usar de Visible Cukes también).

0

Suena genial. Tal vez no quieras que algunos de los escenarios de pepino estén disponibles para todo el mundo. Si un desarrollador pone algo sensible, como nombres de personas/contraseñas de desarrollo; o se descubrió un exploit de sitio web y se escribió un escenario de pepino para verificar que estaba parcheado.

3

Uso Lowdown (http://lowdownapp.com) para comunicar funciones de ida y vuelta con los clientes. El objetivo de pepino es que sea específico para el negocio, por lo que no debería tener que traducirlo a otro formato para la documentación. Sin embargo, puedo ver a dónde vas.

Puede usar http://seleniumshots.com/ para obtener capturas de pantalla de su aplicación de las pruebas. Sin embargo, todavía no sé si aún está fuera de la versión beta.

Cuestiones relacionadas