Facet
DeutschInstall

FOR SUPPORT, PRODUCT AND TECHNICAL WRITERS

The help article says 14 days. The code says 30.

Support answers from the article, the customer gets the wrong answer, and nobody noticed. FACET ties the explanation to the place in the code it comes from — when the rule changes, the article flags itself.

RECORDbilling/refunds/refund-window.yaml
knowledge:  prerequisite_knowledge:    answer: A refund is possible within 14 days of purchase.  common_pitfalls:    answer: Counting from delivery instead of from purchase.  success_signal:    answer: The order shows “refund requested” with the date.

HELP

Get a refund for an order

You can request a refund within 14 days of purchase. The window counts from the purchase date, not from delivery. Afterwards the order shows “refund requested” with the date.

Source: billing/refunds/refund-window · 3 Knowledge slots

Illustrative example · the article is drawn from components, not generated

AND WHEN 14 DAYS BECOME 30?

The deadline changes. The article flags itself.

Every generated help text knows what it was made from. When the rule changes, facet docs check reports the article as stale — before a customer reads the old deadline. The rule gets corrected, the text regenerated.

RECORDbilling/refunds/refund-window.yaml · diff
knowledge:  prerequisite_knowledge:    answer: A refund is possible within 14 days of purchase.    answer: A refund is possible within 30 days of purchase.  common_pitfalls:    answer: Counting from delivery instead of from purchase.
TERMINALfacet docs checkstale
$ facet docs checkstale: docs/help/refunds.md (billing/refunds/refund-window)    input docs/facets/features/billing/refunds/refund-window.yaml changed since generation 1 artifact(s) checked — 1 need regeneration A changed input does not always mean the article is wrong. Review thediff before regenerating; a refactor that preserves behaviour needs nothing.

Illustrative example · lines shaped like facet docs check output; an artefact’s provenance is recorded with facet docs record

ONE SOURCE, SEVERAL READERS

One answer. In your readers’ language.

Customer, support, sales: each needs a different explanation of the same rule. Agents write them from the same source instead of rereading the code for every article. What nobody has answered yet appears in no text.

SOURCEbilling/refunds/refund-windowknowledge

  • HELP

    Get a refund for an order

    Within 14 days of purchase. The window counts from the purchase date.

    prerequisite_knowledge · common_pitfalls · success_signal

  • FAQ

    Why was my refund refused?

    The 14 days count from purchase, not from delivery.

    common_pitfalls

  • INTRO

    Refunds for new support teammates

    What the window is, what it is not for, and how a customer sees it worked.

    prerequisite_knowledge · not_for · success_signal

Illustrative example · titles and excerpts are invented, the slot names are the specification’s

WHAT FACET DOES NOT DO HERE

The source does not write itself.

The source needs domain review. Unconnected wikis do not update automatically.