Skip to content
repo

user-guide-diataxis

Superseded by product-documentation — see the updated journey.

1 skills2 human gates15–35 min/session

The contract

Use it when
Install product-documentation instead. This journey is preserved for existing installations only.
You provide
See the product-documentation journey.
You receive
See the product-documentation journey.

Where you decide

The agent pauses at these points. You choose whether to continue, redirect, or stop.

See the product-documentation journey

What changes when you install this

Superseded. Install product-documentation — it provides the same guide-authoring flow plus four additional modes (revise, retrofit, audit, verify) and removes the mandatory four-subdirectory skeleton. Existing user-guide-diataxis installations continue to work; new-guide routes to author-product-docs automatically.

The journey

Deprecated. This journey is preserved so existing /journeys/user-guide-diataxis/ links continue to resolve. The canonical journey is product-documentation.

Install product-documentation for new projects. The new-guide skill in existing installations routes to author-product-docs automatically — the workflow is unchanged.

1. Use the compatibility shim

  • You provide: A guide-authoring request.
  • Agent does: Routes the request to author-product-docs (product-documentation pack) via the new-guide compatibility shim.
  • Output: Guide content authored by author-product-docs. Install product-documentation directly to access all five authoring modes without this compatibility layer.

Human gates

For each gate, everything you need to make a confident decision.

  • Confirm the Diátaxis category

    Trigger
    Before new-guide begins drafting
    Time
    3–5 minutes
    What to check, good, bad, consequence

    What to check

    • See the product-documentation journey — it reflects current behaviour.

    What good looks like

    See the product-documentation journey.

    What bad looks like

    See the product-documentation journey.

    Consequence of skipping

    See the product-documentation journey.

  • Review the drafted guide

    Trigger
    After new-guide produces a draft
    Time
    10–20 minutes
    What to check, good, bad, consequence

    What to check

    • See the product-documentation journey — it reflects current behaviour.

    What good looks like

    See the product-documentation journey.

    What bad looks like

    See the product-documentation journey.

    Consequence of skipping

    See the product-documentation journey.

Typical session

Agent turns
4–7
Human gates
2
Wall-clock time
15–35 min

Install

agentbundle install --pack user-guide-diataxis

Skills in this pack

  • new-guide2 gates

    Routes to author-product-docs (product-documentation pack). See the product-documentation journey for the full workflow.