# SaaS documentation page review

Review brief and locally tested fictional example

Review one public developer task with the blank brief, then use the answer-location checklist and fictional HarborDesk example to check your draft. Replace the example facts with verified product details. The saved file is a manual review tool; it does not run an API or validate a live page.

Pack version 1.0 · 16 September 2026. Brief version 1.0.

Guide: https://rankecho.io/resources/fix/documentation-page

## Part 1 — Review brief and fictional example

Copy this manual brief for one public developer task. Complete the evidence and owner fields before changing the page; the filled HarborDesk example shows the required level of specificity.

# SaaS documentation-page review brief

Version 1.0 — manual review brief

## Task control
- One public reader goal, governing source, owner, and canonical URL [required]:
- Public/private eligibility and access boundary [required]:
- Supported version, prerequisites, role, permission, object, or ID [required]:
- Last verified date, review cadence, and update triggers [required]:

## Completion contract
- What the task reads or changes, including side effects:
- Exact request, interface action, or ordered steps; inputs, headers, and safe placeholders:
- Expected status, response, state, and success check:
- Failure signals, corrections, and escalation owner:
- Security, privacy, plan, rate, region, and version limits:
- Setup, reference, version, troubleshooting, support, and honest product links:

## Manual review
- Map eligibility, prerequisites, steps, result, errors, recovery, and next action to visible answer locations.
- Verify product facts with their owners. Inspect initial HTML and a browser.
- Where authorized, test the real task with safe non-production data; record request, response, side effects, cleanup, and unresolved cases.
- Ask a representative reader to attempt it. Inspect indexing and query data separately.

## Proposed measurement
- Discovery: eligible impressions and clicks; separately identified AI-referral sessions.
- Completion: defined task starts, validations, recoveries, support escalations, and product actions already observable.
- Keep search, referral, session, action, account, and customer denominators separate; preserve unknown attribution and avoid causal claims.

## Filled locally tested fictional example: HarborDesk
- Goal, source, owner: read an existing export's status from a fictional API v1 task specification; proposed owner is the API documentation team.
- URL and eligibility: https://harbordesk.example/docs/v1/read-export-status is a public-task placeholder with no working API. Real tokens, account data, and restricted instructions stay private.
- Version and access: API v1, exports:read, existing ID exp_demo, and the fixed fictional-read-token accepted locally. This is not a real OAuth or scope test.
- Request description: GET /v1/exports/exp_demo with Authorization: Bearer fictional-read-token. It reads status and creates, exports, or downloads nothing. Do not send it to the example domain.
- Expected result: 200 {"id":"exp_demo","status":"ready","row_count":12}.
- Failures: missing token → 401 {"error":"invalid_token"}; wrong token → 401 {"error":"invalid_token"}; exp_missing with the fixed token → 404 {"error":"export_not_found"}.
- Before: 200 HTML at the same URL with the same title, canonical, and robots value; decisive facts were only in script[type=application/json]. Answer checks found 0 of 4.
- After: 200 HTML with #prerequisites, #request, #response, and #errors sections plus a[href] navigation. Answer checks found 4 of 4.
- Exact request receipt: success / missing token / wrong token / missing ID → 200/401/401/404.
- Update triggers: version, permission, endpoint, header, response, status, error, owner, URL, or access-policy changes.
- Proposed measurement: task-URL impressions and clicks, separately identified AI referrals, status-check starts and successes, recoveries, and support escalations where defined.
- Unperformed: browser, real API, provider/canonical, user-completion, site-search, indexing, query-performance, and product-action tests.

Manual review brief with a locally tested fictional example. Replace the placeholder facts with owner-approved evidence and complete the unperformed real-page checks before publication.

## Part 2 — Where should each developer answer appear?

Lead with who can do the task, its version and prerequisites, what changes, and what success looks like. Put the complete steps, result, failures, recovery, and next link under descriptive headings instead of hiding a required permission in a sample.

Map each material question to a visible location and governing source. GitHub's public get-a-repository page separately presents permissions, parameters, statuses, and samples. We reviewed its organization only and did not test that endpoint.

| Reader question | Primary location | Facts to verify |
| --- | --- | --- |
| Can I use it? | Opening and prerequisites | Eligibility, version, permission, required object or ID |
| What do I do? | Request or steps | Method, path, inputs, headers, safe placeholders |
| What is success? | Expected result | Status, meaningful fields, side effects, validation |
| How do I recover? | Errors and recovery | Signal, bounded cause, correction, owner |
| Where next? | Task links and action | Reference, version, support, honest product step |

- [Inspect the reviewed GitHub page organization](https://docs.github.com/en/rest/repos/repos#get-a-repository)
- [Use the direct-answer guide for one short answer](https://rankecho.io/resources/fix/direct-answer-block)
- [Use the general brief for broader content planning](https://rankecho.io/templates/ai-search-content-brief)

## Part 3 — What did the local HarborDesk test establish?

HarborDesk is a fictional in-memory API and HTML app tested locally on September 12, 2026. It used no network, account, or external data. Its fixed task reads an existing API v1 export status with ID exp_demo. The exports:read permission label is instructional; the local app accepts one fixed placeholder token and does not implement or validate real scopes.

Before excerpt: “Use this guide to check an existing export.” Decisive facts were only in script[type=application/json]. After excerpt: “Check an existing HarborDesk export using a read-only API v1 request. This fictional request does not create an export.” Four normal initial-HTML sections and direct a[href] links then exposed the answers.

Scope: the check removed scripts, matched fixed strings in named source sections, and exercised four local API rules. It did not run a browser or JavaScript, test a real API or user, or measure site search, indexing, rankings, citations, traffic, or cause. Its 401 and 404 rules are example-specific.

| Check | Exact result | Meaning |
| --- | --- | --- |
| Documentation response | Before 200; after 200 | Same URL, title, canonical, and robots value. |
| Answer locations | Before 0 of 4; after 4 of 4 | Four fixed strings-and-sections checks after script removal. |
| Success request | 200 | {"id":"exp_demo","status":"ready","row_count":12} |
| Missing token | 401 | {"error":"invalid_token"} |
| Wrong token | 401 | {"error":"invalid_token"} |
| Existing token, missing ID | 404 | {"error":"export_not_found"} |


## Use this pack

1. Save a copy for one public developer task and complete its ten blank fields from current product, engineering, security and support sources.
2. Map each decisive answer to a visible page location. Verify the real task in an authorized environment and record unresolved cases and unperformed checks.
3. Keep the HarborDesk observations separate from real API, browser, indexing and user-completion evidence. Define measurement events before using them.

Inspect a sample fix — https://rankecho.io/sample-fix. Evaluate the Fix Engine — https://rankecho.io/product/fix-engine for bounded changes with human review and manual shipment. Full-page writing is a separate content add-on — https://rankecho.io/pricing/content, not included with the visibility subscription.