# [Product name]

<!-- Original template: CC-BY-4.0, Jon Bishop. Replace placeholders and remove instructions before publishing. -->

[Product] helps [specific developer or team] [complete a concrete task] by [briefly explain the mechanism].

## What you can do

- [Core capability and a concrete use case. Link to its guide.]
- [Second capability, only if it helps readers understand the product.]

## See the programming model

<!-- Add a small, representative code example or describe one workflow. Explain its output. Label illustrative snippets that cannot run on their own. -->

[Show one interaction and the result a reader should expect.]

## Get to your first result

### Prerequisites

- [Supported runtime or version]
- [Required account, service, domain or API key, if applicable]
- [Any cost or deployment assumption relevant to this tutorial]

### Run the example

1. [Install or scaffold the example.]
2. [Configure credentials using placeholders; do not publish real secrets.]
3. [Run the smallest meaningful action.]
4. [Inspect a specific result and explain how to recognize success.]

### If it does not work

[Link to a troubleshooting section and give a useful diagnostic for the most likely failure.]

## Choose your setup

<!-- Keep only the choices your product supports. State which route is recommended and who should use alternatives. -->

| Route | Useful for | Requirements and limitations | Next guide |
| --- | --- | --- | --- |
| [Default route] | [Audience] | [Account, maintenance or environment requirements] | [Link] |
| [Alternative] | [Audience] | [Differences in support, features or deployment] | [Link] |

## Documentation

- [Quickstart: produces the first useful result]
- [Concepts: explains the model]
- [Reference: lists API and configuration details]
- [Examples: shows specific use cases]

## Support and contributions

- Usage questions: [channel and its purpose]
- Bugs: [issue link and required reproduction details]
- Account or deployment help: [appropriate route]
- Contributions: [guidelines]

## License and operational boundaries

[State the actual license and any component/edition exceptions. Link to license files.]

[Explain relevant telemetry, maintenance, support or security behavior with links to authoritative details. Do not promise terms you cannot substantiate.]

## Review before publishing

- Can an unfamiliar developer explain the product after reading the opening?
- Are the stated prerequisites sufficient for the example?
- Have you executed the commands in the supported environment?
- Does the guide show a clear end state and a recovery route?
- Are links, licenses and edition boundaries accurate?
- Are performance claims supported and scoped to the relevant context?

Template attribution: Jon Bishop. Licensed CC-BY-4.0. Identify modifications when redistributing this template. Referenced example products retain their own rights.