Feature Doc Template
Template and acceptance criteria for adding Helm product documentation for new features.
Use this page as the writing standard for new Helm feature documentation.
Client-facing page shape
---
title: Feature Name
description: What a customer, forwarder, or clearing agent needs to know.
---
{/* feature: stable-feature-id */}
Briefly explain the feature in user-visible terms.
## When this appears
State the trigger or workflow stage.
## What to do
List the actions expected from the user or external operator.
## What the status means
Explain any labels, warnings, generated files, or totals shown in Helm.
## Limits
State what is an estimate, what depends on external systems, and what may change.Internal page shape
---
title: Feature Name
description: Internal procedure for operating or supporting the feature.
---
{/* feature: stable-feature-id */}
Describe the operating purpose.
## Procedure
Write the review or operating steps in order.
## Data and integrations
Name the tables, routes, jobs, or external systems involved at a high level.
## Failure modes
List common errors, stale states, missing data, and escalation paths.
## Release notes
State what changed and whether customers, forwarders, accounts, or clearing agents need communication.Acceptance criteria
- The feature is listed in
apps/helm-docs/features/helm-features.json. - Every audience in the feature entry has at least one docs path.
- Every docs path exists.
- Every docs path has
titleanddescriptionfrontmatter. - Every docs path includes a matching
{/* feature: stable-feature-id */}marker. - The static docs site builds successfully.