Example deliverable

Synthetic demonstration — fictional data, not customer work or a testimonial.

Synthetic source material

Product: AtlasDesk SaaS. Audience: developers. Getting started: use API v2 and POST /v2/tasks. Example: curl -X POST https://example.invalid/v1/tasks. Authentication: send an API key in the Authorization header. Setup: authenticate using an API key; how to obtain one and its permissions are not documented. Recovery: retry failed requests immediately; no retry limit or verification step is supplied.

Example deliverable

# SaaS Documentation Quality Audit

Prepared from your supplied material. Recommendations and hypotheses require your review. No external accounts were accessed or changed.

The AtlasDesk developer documentation has a version mismatch between its stated API and example, an undocumented API-key acquisition and permission model, and a recovery instruction that lacks limits or verification. These gaps make the getting-started path incomplete for developers.

## Blocking documentation gaps

The documentation does not explain how to obtain an API key or what permissions it has. It also gives no retry limit or verification step for failed requests. These missing prerequisites and recovery details block a developer from completing setup and handling failures reliably.

Source excerpts:
> how to obtain one and its permissions are not documented
> no retry limit or verification step is supplied

## Contradictions and unclear guidance

The getting-started section says to use API v2 and POST /v2/tasks, but the example uses a v1 endpoint. This contradiction makes it unclear which endpoint developers should call. The recovery guidance to retry failed requests immediately is also unclear because it does not define when retrying is appropriate or how to confirm success.

Source excerpts:
> use API v2 and POST /v2/tasks
> curl -X POST https://example.invalid/v1/tasks
> retry failed requests immediately

## Source-grounded rewrites

A corrected getting-started example should use the stated v2 endpoint: curl -X POST https://example.invalid/v2/tasks. The authentication section should include a placeholder for the key-acquisition process, such as: Obtain an API key from [key-acquisition source]. The recovery section should add placeholders for limits and verification, such as: Retry failed requests up to [retry limit] times, then verify the task state using [verification method]. These rewrites preserve the supplied facts without inventing endpoints, commands, permissions or product capabilities.

Source excerpts:
> use API v2 and POST /v2/tasks
> send an API key in the Authorization header
> retry failed requests immediately

## Prioritized documentation checklist

1. Resolve the v1/v2 endpoint contradiction in the getting-started example. 2. Document how to obtain an API key and its permissions. 3. Add a retry limit and a verification step to the recovery guidance. 4. Confirm whether the example domain and request format are intended for developers. 5. Add a success-verification example after creating a task. These items are prioritized by how directly they block setup, authentication and failure recovery.

Source excerpts:
> use API v2 and POST /v2/tasks
> curl -X POST https://example.invalid/v1/tasks
> how to obtain one and its permissions are not documented
> no retry limit or verification step is supplied

Browse offers