Recipe

Feature flag description writer

Generate consistent, searchable descriptions for every feature flag in your codebase using a structured prompt template.

Ingredients

A feature flag key (e.g. enable_dark_mode)
The owning team or squad name
Rollout percentage or targeting rule
Expected lifetime (days, weeks, permanent)
Link to the tracking issue or spec

Prompt template

Write a one-paragraph description for the feature flag
"{flag_key}". Include:

- What the flag gates (one sentence)
- Who owns it (team: {team})
- Current rollout: {rollout}
- Expected removal date or condition: {lifetime}
- Reference: {issue_link}

Tone: neutral, factual. No marketing language.
Max 80 words.

Example output

enable_dark_mode — Gates the application-wide dark mode toggle on the settings page. Owned by the Design Systems team. Currently rolled out to 25% of production users via gradual percentage ramp. Expected to reach 100% and become permanent by Q3. Tracking issue: PROJ-421.

Usage notes

Run this recipe for every new flag before merging the PR.
Store the output in your flag management tool or a flags.md registry.
Re-run when rollout percentage or ownership changes.

← All recipes