Product Documentation Change Pack

# Product Documentation Change Pack

Turn a defined product change into documentation with runnable examples and review gates.

1Overview

A documentation patch, example checks and a maintenance owner list.

2Requirements

Requires the actual product contract or code and an example/test environment.

3Steps

1. 1. Identify the changed behavior and the users whose existing workflow is affected.

2. 2. Gather authoritative API/schema/code evidence and mark undocumented assumptions.

3. 3. Draft task-oriented instructions and examples that match the current behavior.

4. 4. Run examples where possible; label unrun steps and verify links and version scope.

5. 5. Review the patch with the responsible owner and record when the examples need revalidation.

4Worked example

6. Input

```text Change: GET /items now requires limit. Existing quickstart calls /items without that parameter. ```

7. Expected result

```text Documentation patch: show GET /items?limit=20, explain the accepted range from the actual contract, and add a migration note for existing clients. Validation: test the shown request against the intended API version before publication. ```

5Acceptance checks

The example includes the new required parameter without inventing an accepted range.

6Limits

This workflow does not keep documentation synchronized automatically; repository ownership and checks must enforce that.

7Suggested tools

• Git: Trace the contract change and edit documentation
• Your AI assistant: Draft task-focused guidance
• GitHub or your code host: Review and validate the documentation patch