A skill/package that helps teams document feature flags with required fields (name, purpose, default, rollout, owner, kill switch, cleanup) to ensure operability and timely cleanup.

Stars

19

7-day growth

No data

Forks

11

Open issues

0

License

MIT

Last updated

2026-07-29

AI repository intelligence
FR-AI / ANALYSIS

Why it is worth attention

It enforces a structured, standardized approach to feature flag documentation, reducing technical debt and improving rollout safety, with built-in bilingual support (English/Chinese).

Who it is for

  • Developers managing feature flags
  • DevOps engineers responsible for flag rollouts
  • Product managers coordinating feature releases
  • Technical writers maintaining flag catalogs

Use cases

  • Documenting a single feature flag in a standardized format
  • Building a catalog of all feature flags in a project
  • Generating bilingual (EN/ZH) flag documentation for global teams
  • Setting up automated flag cleanup triggers based on documentation fields

Strengths

  • Clear, opinionated schema with five mandatory fields plus rollback info
  • Bilingual output (English, Chinese, or bilingual) controlled by lang option
  • Open source (MIT license) and easy to install via npx
  • Integrated into a broader skills ecosystem for repeatable workflows

Considerations

  • Assumes the user already has a GitHub package infrastructure set up
  • Full workflow and rules are deferred to a separate SKILL.md file, not visible in README
  • Scope is limited strictly to feature flag documentation; out-of-scope tasks are not supported

README quick start

Feature Flag Docs

Document feature flags: name, purpose, default, rollout, owner, kill switch, cleanup.

中文简介: 你写可运营、可清理的特性开关文档。 — 详见 README.zh.md.

What this skill does

  • You document flags so rollouts are operable and cleanups happen
  • Scope: See SKILL.md vertical lock.
  • Deliverable: See SKILL.md deliverable.
  • Triggers: feature flag docs, flag catalog, rollout flag, 特性开关文档, feature toggle.

Install

After this package is on GitHub:

npx skills add / --skill feature-flag-docs

Local monorepo: point your agent at skills/feature-flag-docs/ (this folder).

Options

OptionValuesDefault
langen · zh · bilingualen
setsingle · catalogsingle

Runtime output language follows lang (default en). Skill docs stay EN-primary.

When to use

UseDon't
(see bullets)(see bullets)

Use

  • When you need feature-flag-docs workflow

Don't

  • Out-of-scope tasks listed in SKILL.md

Deliverable

See SKILL.md deliverable.

Full workflow, hard rules, and QA: see SKILL.md.

Example

Monorepo sample (if present): ../../output/samples/feature-flag-docs-example-01.md

License

MIT — see LICENSE.

Related repositories

Similar projects matched by category, topics, and programming language.

MoonshotAI
Featured
MoonshotAI GitHub avatar

Kimi-K3

Kimi K3 is an open-weight, 2.8T-parameter native multimodal agentic model with a 1M-token context window, designed for frontier coding, knowledge work, and reasoning tasks.

AI & Machine LearningAI Agents
3,348
xuchonglang
Featured
xuchonglang GitHub avatar

investing-for-beginners

A structured investing guide for Chinese beginners covering US stocks, options, and cryptocurrency, with focus on foundational concepts and risk awareness.

Blockchain & Web3
2,739
Krishnagangwal
Featured
Krishnagangwal GitHub avatar

CS-Fundamentals

A curated collection of Computer Science fundamentals (PDFs, notes, cheatsheets, interview question banks) for placement preparation, covering seven core subjects plus general resources.

Data & DatabasesDatabases & Storage
2,326