Home TestCase What should I include in the "Brief description" field?

What should I include in the "Brief description" field?

Last updated on Apr 09, 2026

Short Answer: Write a 1–2 sentence summary of the flow or what needs testing. Use the sample hints shown for format and brevity.

PreRequisites

  1. Have the main flow steps or acceptance criteria in mind.

Steps

  1. Open the "Brief description" text area ("Describe the flow or what needs to be tested...").
    The text area is ready for input.

  2. Write a concise sentence describing the goal and key steps (for example, "Users log in with email + password, then complete 2FA.").
    Keep it short and focused on the main flow.

  3. Add important variants or edge cases if relevant (for example, "Admin edits user permissions.").
    Include only critical variations that affect testing.

  4. Proceed to "Generate test cases" once satisfied with the description and other inputs.
    The description is submitted as part of the generation input.

Troubleshooting

  1. Generated test cases do not match the intended flow.

    Likely Cause: The description is too vague or missing key steps or variants.

    Action: Edit the "Brief description" to include clearer steps or scenarios, then regenerate.

Note: Sample hints on the page include:

  • "Users log in with email + password, then complete 2FA."

  • "Admin edits user permissions."

Use these as a model for writing concise, clear descriptions.