> For the complete documentation index, see [llms.txt](https://docs.didge.io/home/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.didge.io/home/checkpoints/template.md).

# Template

Here’s a clean, reusable “Checkpoint Introduction” structure you can apply to any sub-domain checkpoint (Incoming Goods, Cooking, Chilling, etc.). It keeps the intent up front, and leaves setup/how-to for the End-User/Admin sections that come later.

<br>

### Checkpoint Intro Structure (8–10 headings)

1. Overview
   * One-paragraph summary of what this checkpoint is and what it’s for.
2. Where This Fits
   * The domain/sub-domain context (e.g., Receiving → Incoming Goods) and what happens before/after.
3. Intent and Outcomes
   * What “good” looks like: compliance outcome, operational outcome, reporting outcome.
4. Use Case
   * The primary scenario(s) this checkpoint supports (keep it at 1–3 bullets).
5. Problem Statement
   * The risk or failure modes being addressed (what goes wrong without it).
6. Solution Approach
   * How the checkpoint addresses the problem at a high level (not steps, not config).
7. Key Concepts and Definitions
   * Any terms that matter for understanding (e.g., limits, corrective actions, evidence, roles).
8. User Journey Summary
   * A short flow at “story level” (e.g., perform check → evaluate → respond → record).
9. Outputs and Evidence
   * What data/artifacts it produces (records, logs, exceptions, reports, audit trail).
10. Scope and Assumptions

<br>

* What’s in scope/out of scope, prerequisites, dependencies, and constraints.

<br>

If you want the *leanest* version (8 headings), drop Key Concepts and Definitions and Scope and Assumptions unless a checkpoint is unusually complex.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.didge.io/home/checkpoints/template.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.