How to Turn a Crawl into Documentation, User Stories and Test Coverage

By the end of this guide, you'll have a written description of your app, a set of user stories with success and failure scenarios, and a test plan linked to each scenario that matters.

Site documentation is included on plans that list it on the pricing page; it isn't available on the free plan or during a trial. Generating documentation and test plans uses credits, so you choose when to run it, and you can see an estimate first.

Step 1 — Run a full crawl

Documentation is written from a crawl, and a full exploration is where you start. Test executions don't produce it. You can also turn on Document this site when you start an exploration, and the job starts when the crawl finishes. On a Diff exploration that only works once the exploration it compares with is already fully documented; then you pay only for the pages and sections that changed. Scheduled Diff explorations follow their baseline and don't take the option. Pipelines can ask for it too through the CI/CD API.

Step 2 — Generate the documentation

Open Site Intelligence → Documentation, pick the environment, and choose Generate. You'll see a credit estimate before anything is spent. Page and section documentation is always included, user stories are per section, and the site overview is always written last. You can limit a job to some sections; the overview then covers only those.

[Screenshot: the Generate documentation dialog with the credit estimate]

Step 3 — Read what BlackBat AI wrote

• Overview — the big picture of what your app does.
• Sections — each section's documentation and the pages in it, with screenshots of each page.
• User Stories — each story with its role, goal, preconditions, and a success scenario plus negative ones (validation, missing input, illegal action).

Anything you edit is never overwritten by regeneration. If the model has a newer version of a story you changed, it shows up as an update you can accept or dismiss.

Step 4 — Review and approve stories

Stories can't be edited by hand. To change one, use Revise and describe the change in plain words; BlackBat AI rewrites it (this uses credits). History shows earlier versions. Approve a story once it matches how your app should behave.

Open Pages on a story card to see screenshots of the pages it touches.

Step 5 — Cover the scenarios with test plans

Each story card shows how many of its scenarios have a test plan. Open Scenarios and, for each one, Link plan to attach an existing plan or Generate to have BlackBat AI write one. To fill many gaps at once, use the bulk generation panel at the top of the tab and set a credit limit. Use Not fully covered to list only the stories that still have gaps. Scenarios BlackBat AI can't decide alone are listed for you to handle one at a time.

[Screenshot: a story card with its scenarios, plan chips and the Link plan / Generate buttons]

Step 6 — Keep it current

After later crawls, the Changes tab shows what changed between two snapshots, with before and after screenshots for pages. If a plan's scenario changed after it was linked, the plan is marked Outdated; choose Still matches to confirm it.

What to try next

• How to Read the Navigation Map — see the structure these stories are built on.
• How to Generate a Test Suite from a Plain-English Prompt — write plans by hand for flows the stories miss.

Want this for your own app? Start a free run.