Test Writing Service: Best Practices

Test Writing Service Best Practices

The Test Writing Service (TWS) lets users request batches of 20 tests and get these tests back in a passing state. This means that the TWS gives users tests that can be added to their test suite for immediate execution without a need for optimization.

To learn more about Rainforest Test Writing Service.

The most critical component that can define a successful or unsuccessful TWS run is the input submitted. To ensure a high-quality output and speed up the process so you get your tests back fast, we recommend the following guidelines.

A working environment.

This is a very common source of issues preventing successful test delivery.

  • Specify the environment and let us know if you’re using more than one.
  • Make sure the environment is included in the Sites and Environments section of your Rainforest account by going to Settings in the left panel then click Sites.
  • Ensure that the environment is accessible 24/7 - most test writers are in different timezones and they should be able to access the environment at any point. If there are any known limitations (for e.g. downtime during weekends for maintenance), please let us know when you submit your request.
  • If required, the environment should be able to support multiple concurrent testers.
  • Communicate any major known defects in the app or test environment.

Credentials. Provide a working set of credentials, when needed.

Good instructions. What qualifies as a good set of instructions?

  • A brief but descriptive test title: Think of something that will help you identify it and use it later when you add it to a feature folder and/or run group(s).
  • A descriptive test outline: There should be detailed instructions on what the test writer should do. Ensure that there is no ambiguity in the outlines and that there is a helpful indication of what the expected outcome of the test should be, so test writers know if something is working as intended or not.
  • Avoid business-specific or sector-specific jargon: To make the outlines as test writer-friendly as possible, do not use business jargon. There’s a good chance that this will be the first time test writers are encountering the app and may not be familiar with it. Be as clear as possible and try not to use terms that are not reflected in the app.

Use video, if possible: The preferred method of input is videos as this provides better clarity for test writers because the video contains a visual of what the test should cover. Video walkthroughs are a narrated recording of your screen that walks through the functional test you want to be created. To help clarify what needs to be written, be sure to narrate the actions you are taking and the expected results you need to be verified in the test. Verify that the video is accessible and that test writers will not have to request permission.

For more information on how video walkthroughs work, read our help article here.

Example of a video walkthrough:

If you have any questions, please feel free to reach out to us at [email protected] or through Intercom!

Updated 2 months ago

Test Writing Service: Best Practices

Test Writing Service Best Practices

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.