FPF Authoring Conventions & Style Guide
About this pattern
This is a generated FPF pattern page projected from the published FPF source. It is canonical FPF content for this ID; it is not a FPF Reference product feature page.
How to use this pattern
Read the ID, status, type, and normativity first. Use the content for exact wording, the relations for adjacent concepts, and citations to keep active work grounded without pasting the whole specification.
Type: Architectural (A) Status: Stable Normativity: Normative (unless explicitly marked informative)
Use E.8 when you are writing, revising, or reviewing one FPF pattern and need to know what shape, voice, reader-recognition function, and assurance material the pattern must carry before it can be treated as mature FPF text.
Relations
Content
Use this when
Use E.8 when you are writing, revising, or reviewing one FPF pattern and need to know what shape, voice, reader-recognition function, and assurance material the pattern must carry before it can be treated as mature FPF text.
For the whole account of an FPF, DPF, or LPF and its substantive profiles, reuse the twelve content functions through E.8:4.1.4 and E.11.PFP:4.7. Those functions guide the explanation at each selected scale; the individual-pattern heading grammar remains the form for individual pattern bodies.
Use it especially when a draft is technically correct but hard to use: the cold reader cannot tell when to apply it, what action to take, what mistake that action prevents, which related pattern defines or constrains a specific outside claim, or which assurance material is informative rather than the first user-facing guidance.
Not this pattern when. Use E.9 when the main work is deciding why FPF should change and how that decision is distributed across patterns. Use E.19 when the main work is an admission or refresh review. Use the local domain pattern when the question is what FPF says inside that domain rather than how a pattern should be authored.
What goes wrong if missed
A pattern can satisfy a checklist and still be practically unreadable. It may open with package architecture instead of a recognisable working moment, bury its payoff, hide the pattern that defines or constrains a specific outside claim, or let assurance prose silently replace the reader-facing claim. The result is a formally neat text that authors can defend but practitioners cannot reliably use.
What this buys
E.8 gives FPF authors one shared pattern shape and one shared authoring discipline: recognition text first, assurance text second, canonical sections present, terminology kept stable, SoTA used as current practice grounding rather than decoration, and practical consequences visible before a reader has to reconstruct the architecture.
First useful move. Put the working situation, first action-guiding move, practical payoff, ordinary boundary, and nearest heavier assurance condition into the recognition text before tightening template details or conformance material.
Solution and working move. Solution gives the pattern's conditional answer to its Problem frame, Problem, and Forces: what the reader should do or decide, under which conditions, what result to seek, and when to stop or return. A working move is ordinary reader-facing wording for one such action or judgement. Reserve U.Move, dated U.Work, and U.Transformation for claims that actually assert those admitted objects. E.11.PUA governs use of one selected Solution to reach the first useful result. When alternatives are formally qualified under A.22.CGUS, call them continuation candidates; E.18.3 applies only when the selected CGUS uses a qualifying transformation-flow substrate.
Move wording in pattern prose. In ordinary prose, say recommend this pattern use, coordinate these uses, or show their total order when those are the actual claims. When the durable governed object matters, use its exact published designation under E.11.PUR: PatternUseRecommendation@Context, PatternUseCoordination@Context, or PatternUseSequence@Context; the suffix is retrieval wording, and the sequence designation requires an admitted total order for the named use. For any other claim, recover the actual relation under its governing pattern. State what cited content contributes and use E.10.MOVE when the current relation remains unclear.
Cheap stop. If the draft already gives a cold reader the working situation, first useful move, practical payoff, ordinary boundary, and nearest heavier assurance condition, do not add more authoring apparatus just to look mature. Use conformance material to verify that guidance; do not let it replace the guidance.
FPF-governed wording extension. Add heavier assurance, conformance, SoTA, or relation material only when it changes correctness or use: it repairs a false claim, stabilizes the primary EntityOfConcern, supplies a missing concrete contribution, grounds a practical payoff, or states an action-changing boundary. Cite the exact pattern that defines or constrains the live value.
When an authoring pass claims quality improvement rather than ordinary drafting, keep these pattern responsibilities distinct: E.22 frames the improvement-oriented quality-evaluation question, the object-under-improvement evaluation such as E.21 or E.9.DA supplies value meanings and stop meanings, C.16.Q repairs overloaded quality and evaluative-characterization wording, C.25 carries engineering quality-family endpoints when those endpoints are claimed, and E.23 governs any repeated quality-improvement method. Closing checklist rows or satisfying a review profile is not by itself quality improvement.
When a pattern claims practical payoff through a visible score or other proxy, name the intended value and the relation by which the proxy bears on it. If the proxy is being treated as the value itself, apply E.13 before admitting the payoff claim.
Quality or projection evidence placement. Development, quality-review, projection, assembly, and landing evidence belongs in its own evaluation, review, projection, or release carrier rather than in the pattern body. Keep it in a pattern only when that work is the pattern's declared EntityOfConcern and intended-reader use. A Part E pattern may govern FPF authoring, review, evaluation, entry, or publication, but it does not narrate the development of its own current version. Judge placement by the sentence's use, not by a blacklist of words.
Pattern positions across coupled flows. During drafting, E.21 questions may guide a focused author-side check. A product-level conclusion still requires an independent E.21 evaluation and the applicable E.19 admission review. Keep their objects and evidence distinct even when an applicable flow relation connects drafting, review, publication, use, and later refresh. A publication may guide or constrain later Work; assert the actual Work and its evidence only through the patterns that admit those claims.
Maturity rule. Section completeness is not pattern maturity. A pattern matures when its Problem frame, Solution, worked cases, boundaries, source/SoTA use, relations, consequences, and conformance checks all point to the same usable action guidance for the declared reader and use. If the reader still needs the DRR, source notes, campaign handoff, or author memory to know what to do, the pattern is not mature for that use.
Primary EntityOfConcern in plain terms. The primary EntityOfConcern of E.8 is the authored FPF pattern: its canonical sections, reader-recognition function, wording discipline, examples, rationale, anti-patterns, SoTA-Echoing, and relations.
Primary working reader. The first reader is an FPF author or reviewer shaping pattern prose for later practitioners and managers. The downstream practitioner is the reader the pattern must ultimately serve, so the authoring guide must model the same recognition discipline it requires.
Pattern Kind In Plain Terms
An FPF pattern supplies action- or judgement-guiding content for a recurring working situation. In ordinary phrases such as “use this pattern” and “apply this pattern”, the acting participant is the person or other capable system; the pattern is the guidance that participant uses.
Call the pattern content a U.MethodDescription only when it describes one independently admitted U.Method under A.3.2 and that distinction matters to the current claim. Keep the Method and its description episteme separate. A Solution can guide future action or help choose a Method without establishing that any dated Work has happened. The intended reader, an actual performer System, local system-role classification, assignment, capability, responsibility, authority, result, and Transformation remain separate whenever those claims are current.
When a pattern or worked case does assert dated U.Work, first recover every actual performer's A.13 core: the admitted U.System, local agential kind and criterion, classification, same obtaining assignment, scope, working situation, window, and adequate core evidence; add a characteristic profile only when its own receiving use consumes it. Then independently admit the Work under A.15.1 from its performance history, enacted Method, time, and containing System. Add F.6 afterward only when the pattern also needs precise assignment-bound attribution through that same assignment. A short practitioner sentence may omit identifiers unused by its receiving claim only when every relation the claim consumes remains recoverable.
Pattern application is ordinary shorthand for user-side use: a user or another capable system recognizes the situation and uses the pattern's Solution to choose the next action or judgement. The pattern body is description-side guidance. Assert a performer, assignment, dated U.Work, result, or U.Transformation only when independently established and material to the receiving claim; a Conformance Checklist checks the authored description and evidenced use but does not replace the Solution.
The pattern's main job is constructive action or judgement guidance. In the opening Problem frame and Solution, state the primary EntityOfConcern, first admissible move, first useful result or practical delta, and only the boundaries that change that move. Error prevention, auditability, conformance evidence, citations, and architecture rationale remain secondary. Repeat another source's distinction only when it adds a local action, case, evidence value, or recognition needed on first reading. State what this pattern governs; do not surround it with an unbounded catalogue of other things.
Name an FPF object by its known kind and state the relation the sentence actually uses. For a neighbouring pattern, state its concrete contribution and cite the PatternID; identify an exact episteme, ClaimGraph, edition, or relation assertion only when that identity changes the receiving use. Put detailed discovery in its dedicated carriers, including README, ToC, E.11, and I.2, and keep compact pattern relations late in Relations. Do not repeat the same boundary or reference family in small prose variants.
Use E.8 to keep the pattern's positive subject and action guidance first. Apply F.19 once to each changed natural span as the common precise-plain-language pass. Its connected reading owns language-general semantic completeness and contribution, coordination and foregrounding repair, kind and loss preservation, and local revalidation after wording changes. These facets form one connected F.19 reading, not separate E.8 checks.
For FPF authoring, E.8 adds the pattern-specific question: can the intended reader still recognize this pattern's EntityOfConcern, working situation, first action or judgement, first useful result, and action-changing boundary before optional modeling and assurance? A cold reader must recover that path from the pattern body; F.19 governs the sentence-level recovery. Do not copy its method, regression table, or result boundary into a local authoring profile.
If the F.19 reading leaves an FPF value unresolved, take the exact E.10, E.10.ARCH, E.10.ROLE, A.6.F, F.18, or subject-pattern route and state that source's concrete contribution. Ordinary PatternID citation and “use this pattern” wording remain ordinary; use an identity-bearing MethodDescription or dated Work claim only when the selected route requires it. Keep development and release evidence outside practitioner guidance unless rewritten as the user's action or boundary.
When an action-adjacent pattern classifies wording or another semio-facing object, connect that classification to the reader's current action. State the admissible use now and any independently grounded boundary that changes that use. Route any other genuinely live claim to the FPF pattern that defines or constrains it.
Semio-Echoing is admissible only for one grounded wording-use overread that changes the reader's action or boundary. Keep the pattern's own EntityOfConcern, positive move, and result primary. Use a thin cue to the exact subject pattern only when its contribution is needed; do not add a generic counterreading catalogue.
Problem frame
FPF grows through patterns written and revised by authors from many disciplines. Without a shared structure, practitioner-facing use order, and semantic writing discipline, the framework would fracture or become formally uniform but harder to use, violating Pillars P‑1 Cognitive Elegance and P‑2 Didactic Primacy.
Problem
Structural drift, stylistic fragmentation, and revision by visible proxies rather than working use threaten five qualities:
- Comparability – readers cannot align patterns lacking common headings.
- Narrative cohesion – prose swings from dry jargon to informal blog style.
- Practitioner use across revisions – cleanup can erase the recognizable situation, first action or judgement, first useful result, ordinary boundary, or affordable stop while leaving a tidier-looking text.
- Semantic and relation clarity – generic heads, false agency, imprecise neighboring-pattern contributions, and drifting package or relation words can change what the prose asserts or what a reader may do.
- Reviewability after guidance – missing or misplaced grounding, boundary, SoTA, conformance, assurance, and publication-reference material can hide a defect or replace the positive guidance it is meant to verify.
Forces
Solution — One template, enriched by style principles
Canonical Pattern Template
Within each pattern, the canonical section headings SHALL appear in the order below.
For each canonical content section heading (1–12), the <Title> component (after the heading separator, e.g. -) MUST start with the canonical section title or its explicitly accepted alias (case-insensitive match; canonical capitalisation preferred); an optional clarifier after an em dash is allowed (e.g., Solution — …).
The mandatory Footer marker (section 13) is the final sentinel and is governed by H-9 rather than the standard <FullId> - <Title> shape.
Extensibility.
Authors MAY add additional sections. Prefer expressing them as subsections under the nearest canonical section (e.g., 4.1, 4.1.1 under Solution). If an additional pattern-level section is necessary, it MUST NOT delete or reorder the canonical sections and its title MUST NOT shadow a canonical title.
Mandatory vs optional.
- Canonical sections 1–13 are mandatory in every pattern.
- Canonical sections carry content. Authors must not use omission placeholders as section substitutes; when a section is intrinsically small, write the smallest content-bearing grounding, misuse, boundary, or reduced-case statement that preserves the section's function.
- First substantive authoring seed. The first non-empty authored body of a pattern SHALL already instantiate the canonical section frame by value: title line, header block, canonical sections 1–13, and the footer marker.
- Seed is not maturity. The canonical frame is a minimum authoring seed, not a mature pattern claim. Before a pattern is used for public, teaching, enterprise, reliance-bearing, landing-input, release-input, or ordinary practitioner guidance, each canonical section must carry enough recognition, action guidance, worked material, source/SoTA use, boundary, consequence, and relation content for the declared use. A material maturity, readiness, admission, or landing claim also needs the independent complete
E.21result selected for that conclusion; an author-side provisional pass or focused repair check does not supply it. A file with correct headings, thin bullets, scenario labels, or compressed DRR recap remains a pattern seed until that content is present or the package explicitly marks it asseedOnly. - Recognition openings and first-minute working guidance belong inside that canonical frame. Any retained pre-template entry material must also stay inside that same canonical frame rather than appearing as one pre-template opening memo. Authors MUST NOT seed one pre-template opening memo and postpone canonical sectioning,
Conformance Checklist, or footer-marker installation to one separateE.19, assembly, or review-repair pass.
Template:
- Title line: Hashes + FullId +
-+ Pattern Title; optional(informative)note. - Header block: Type, Status; optional Normativity override.
- Problem frame
- Problem
- Forces
- Solution
- Archetypal Grounding (Tell-Show-Show; at least one content-bearing grounding slice, reduced grounding case, or ordinary/non-use boundary)
- Bias‑Annotation
- Conformance Checklist
- Common Anti‑Patterns and How to Avoid Them (grounded misuse, text-invited misreading, or a decision-relevant non-use boundary under
CC-SG.11) - Consequences
- Architectural Rationale (
Rationaleis an accepted title for the same function) - SoTA-Echoing (current-best problem answer; by-value comparison at comparable effort; explicit trade-off and adopt/adapt/reject decision whenever external or internal practice changes the Solution)
- Relations
- Footer marker
Footer marker. End each pattern with a single visible sentinel heading line by itself: ### <PatternId>:End. This makes truncation detectable even when HTML comments are stripped or shown by editors. The footer marker is intentionally content-free: do not place prose under it.
Note. Pattern boundaries are still parseable by scanning for the next pattern heading (## …), but an explicit :End marker helps retrieval pipelines (and LLM prompts) distinguish “this chunk is the whole pattern” from “this chunk was cut mid‑pattern”.
Heading & ID discipline (human tooling + retrieval)
FPF is often consumed through full‑text search and retrieval (RAG). A reader or an LLM may see a subsection without its parent headings, so headings must be self‑identifying.
H-1 (Heading shape). Every pattern heading and every subsection heading inside a pattern SHALL follow:
<hashes> <FullId> - <Title> (optional note of non‑normativity)
Exception. The Footer marker is a sentinel heading and is governed by H-9, not by the standard <FullId> - <Title> shape.
H-2 (Heading separator). The canonical separator between <FullId> and <Title> is - (ASCII, space-hyphen-space).
Previously authored text may use Unicode dash variants such as – or — as separators; tooling SHOULD treat those variants as migration candidates, and authors SHOULD migrate touched headings to -.
H-3 (FullId). FullId is the complete address used by this heading grammar.
For a pattern heading it is the PatternID (e.g., A.2, E.10.D1).
For headings inside a pattern, append dot-separated ordinal section numbers after the colon (:) (e.g., A.2:4.4, E.10.D2:3).
Exception: the Footer marker uses the reserved sentinel token :End as defined in H-9.
The colon (:) is reserved for section paths and MUST NOT appear in PatternIDs.
PatternID segments may be numeric or mnemonic. When the surrounding text identifies the framework, the complete PatternID identifies one pattern in that framework; the shape of its segments does not by itself state the pattern's title, meaning, Part, publication position, dependency, Method relation, or use order. A mnemonic segment may help recognition but does not define the pattern.
Whether a PatternID stays with a changed pattern is an authoring decision, not a grammar decision. For a DPF, use E.4.DPF; use E.11.PFP to show current publication position separately. When the surrounding text does not already identify the framework, name the framework together with the PatternID. Add the edition when the reference must select the body published in one edition.
H-4 (Ordinals). Ordinals in section paths SHOULD track the canonical template numbering (1 = Problem frame, …, 13 = Footer marker) to maximise cross‑pattern comparability. During refactors or in previously authored patterns, ordinals MAY be local. In that case, the canonical section title at the start of <Title> is the semantic key; readers and tools MUST NOT infer section semantics from the ordinal alone.
Architectural Rationale is the preferred title of the Rationale function; Rationale remains an accepted alias. Both identify one canonical content section, so a pattern carries exactly one of them. When an existing heading is retitled, repair title-dependent links and direct consumers under E.8:4.1.2; retaining its ordinal alone does not preserve a Markdown return.
Note: the Footer marker itself is exempt from ordinal encoding; it uses the reserved token :End (see H-9).
H-5 (Where kind and normativity are declared). Pattern kind (for example, Architectural or Definitional) MUST be declared in the Header block, not encoded into the heading text. Normativity (normative or informative) MUST also be declared in the Header block when it deviates from the default. If a reminder is needed for readers, authors MAY add a short parenthetical note at the end of the heading, for example (informative) or (non‑normative), but headings MUST NOT use square‑bracket tags.
H-6 (Heading levels). Heading levels MUST preserve a fixed offset between structural layers (Part or Cluster (flat) → Pattern → Pattern sections):
- Part and Cluster headings MUST use
#(level 1) across the file. - A Pattern heading MUST use
##(level 2). - Inside a pattern, each nested section MUST add exactly one
#per level (e.g.,## A.2 - …,### A.2:2 - …,#### A.2:2.1 - …).
H-7 (Ellipsis discipline). Authors MUST NOT use three consecutive full stops/dots (...) as punctuation in headings or narrative prose. Authors MUST use the Unicode ellipsis … (U+2026) instead. For editorial elisions in quotations, authors SHOULD prefer […] to make the omission explicit and distinguish it from retrieval truncation.
Exception: literal three‑dot sequences that are part of an external language’s syntax MAY appear only inside code spans or fenced code blocks.
H-8 (Normative keywords). The key words MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL are to be interpreted as described in RFC 2119, as clarified by RFC 8174 (only when capitalised). Authors SHOULD avoid informal deontic phrasing (“need to”, “is required to”) in normative clauses.
Deontics vs admissibility. Use RFC keywords only for deontic obligations (requirements on authors, reviewers, implementers/tooling, or published pattern or companion texts) — i.e., things an agent can choose to do or omit. Do not use RFC keywords to state definitions, structural invariants, typing rules, or other admissibility conditions of the modeled world.
When you need an enforceable constraint that is mathematical rather than deontic, express it as a non‑deontic predicate using one of: Definition:, Invariant:, or Well‑formedness constraint: (optionally with formal quantifiers). Prefer mathematical terms like cardinality 1..1 (total), 0..1 (partial), or 0..n over deontic adjectives like “mandatory or optional” when the intent is cardinality, not duty.
Admissibility predicate discipline (recommended shape).
When expressing admissibility or validity constraints as predicates (Definition:, Invariant:, or Well‑formedness constraint:):
- Authors MUST NOT use RFC keywords inside the predicate block.
- Authors SHOULD give each predicate a stable identifier and short name (e.g.,
RA‑1 (Locality),RE‑3 (Method gate)), so that Conformance Checklist items can reference it without re‑authoring the rule. - Authors SHOULD write the constraint as a declarative predicate with a truth condition (optionally quantified), for example “every selected interval lies within the declared qualification window”, rather than as “X MUST …”.
- If the constraint needs to be checked as part of pattern conformance, authors SHOULD reference the predicate identifier from the Conformance Checklist, and call out validator behaviour when relevant, rather than duplicating the predicate with RFC keywords.
H-9 (Footer marker sentinel). Footer marker SHALL be a single heading line whose FullId is the pattern ID followed by the reserved sentinel token :End (no ordinals, no title, no square‑bracket tags):
### <PatternId>:End
It is the only allowed heading inside a pattern whose section token is non‑numeric. It MUST be the final line of the pattern and MUST NOT carry any prose. Tooling and readers MUST treat it as a boundary sentinel, not as a semantic section.
H-10 (Publication-token classification and addressability). Before emitting an FPF-governed token as a reference, authors MUST classify it under exactly one of these seven E.8-local publication-token classes and use the matching form:
PatternRefuses one PatternID to name a pattern that continues across editions of the framework identified by the surrounding text. In the assembled publication being checked, it resolves to one complete H2 body, one matching:End, and a truthful ToC status for that PatternID. A reference intended to select the body published in one edition also names that framework edition. A structural checker may verify and report publication conformance but does not establish the pattern's identity, status, or authority.PlannedCatalogEntrynames an explicit future catalogue commitment. It has no current pattern semantics, governing force, prerequisite force, or addressable body; a useful prose mention MUST sayplannedorfuture, and a current semantic dependency MUST cite existing content that supplies the needed definition, constraint, test, method, or other rule, or state the current gap.SectionRefnames one exact heading path inside one current pattern or one framework publication unit declared underE.11.PFP. Authors and tooling MUST read the complete section identifier and its declared scope before examining any substring. For example,STR.Preface:1returns to the Strategy Preface; it does not declare a pattern namedSTR.Preface.LocalDeclaredIdnames an exact declaration within one pattern, such as a conformance clause, component, interface row, or predicate. Its scope is local unless an explicit stable anchor or a separate promotion decision establishes wider use.LocalAliasnames an explicitly declared compatibility alias and resolves to its declared canonical local target.PatternFamilySelectorselects a navigable pattern family using canonical spelling<base>.*. It requires a current base pattern and at least one current matching member and MUST NOT stand in for one exact governing target.NonReferenceTokenclassifies a schematic example or ordinary local prose/code that neither occupies a reference-bearing position nor declares a local public ID. It explicitly denotes no reference; key-like typography or backticks alone do not change that class.
Resolution and checking are declaration-first and context-sensitive. Authors and tooling MUST NOT split complete SectionRefs, strip a local-ID prefix, promote a local symbol by visual resemblance, or replace these classes with an ignore list. An unresolved token in a reference-bearing authoring form is an error; ordinary code or local wording is not silently upgraded to a reference.
H-11 (Assembled Part boundaries and title agreement). In the assembled publication, every compact ToC Part label MUST be a bold separator with a blank line on both sides, not a duplicate structural Part heading. Its title and ASCII - separator MUST agree exactly with the corresponding # Part <letter> - <title> body heading. A reserved body Part that has no compact ToC table, including current Part H, does not require an empty compact label or table.
Unification note: historic A‑ and D‑templates differed only by the presence/absence of Bias‑Annotation and Relations; the unified template keeps the headings everywhere and requires every heading to carry content-bearing grounding, boundary, consequence, rationale, source-use, relation, or reduced-case material rather than an omission placeholder.
The Alexandrian pattern canon historically calls Problem frame “Context”. FPF uses Problem frame because generic Context and universal U.BoundedContext do not identify the actual value a claim needs.
Route each use directly. Recover source-local meaning through F.0.1, use F.1 to select answer-changing sources, state ClaimScope through A.2.6, and use A.1.1 for an admitted bounded-model use. Add F.17 only when a durable address or basis relation is needed, F.9 only for an obtaining Bridge between two exact local senses, and the applicable plane relation for a ReferencePlane claim. Otherwise leave the relation unasserted rather than inferring it from a shared word, source, or context.
Preserve Pattern Use Value Across Material Revisions
A revision is material when the actual change can alter what a working reader recognizes, does, obtains, or must stop doing, regardless of whether the change is labelled as cleanup, clarification, terminology repair, or ontology alignment. Treat the revision as material when it can change at least one of these values:
- the primary
EntityOfConcern, governed kind, direct relation, claim kind, or scope; - the recurring situation or practical question that lets a reader recognize the use;
- a Solution action, action condition, result kind, first useful result, stop, return, risk disclosure, or stronger-neighbor handoff;
- the definition, constraint, test, method, cited-pattern contribution, split, merge, relocation, or source/SoTA stance that changes what the reader may do;
- the asserted commonality, member set, membership rule, order, or governing premise of a list; or
- ordinary first-use affordability.
For this comparison, the earlier edition is the exact accepted pattern edition that this candidate is intended to replace for the declared use. A formatting correction, spelling repair, citation repair, exact mechanical rendering, or wording change is not triggered only when the smallest comparison of the earlier edition and proposed text shows that all these values are preserved. A clean comparison needs no additional positive ledger, evidence table, or pattern section. Physical line count, file size, section count, inventory rows, and the author's label for the change do not establish materiality.
Use one bounded material-revision loop over the actual prose. Before treating a materially revised pattern as authored:
- Recover the useful earlier-edition use at idea level: the recognizable situation and intended reader, first admissible action or judgement, first useful result, action-changing boundary or stop, and any domain claim, example, or relation needed to perform that move. Classify a changing or disappearing earlier-edition use only as retained, a valid outcome whose defective mechanism is repaired, an explicitly authorized retirement with a corrected action or boundary, or unsupported residue.
- Draft the candidate's positive practitioner path in domain-recognizable language before guards: governed subject, recurring problem, action the reader can take, first useful result, and next action-changing condition or stop.
- Compare the earlier edition and proposed text at comparable application effort. Preserve every useful earlier-edition move or deliberately replace it with an at-least-equally-usable action, result, or boundary; admit a candidate-only use only from an exact accepted decision, source/SoTA stance, finding, or working need.
- Apply
F.19to each changed natural span. Remove exactness intensifiers, invented counterreadings, role or process wrappers, formal identities, and assurance apparatus that fail its contribution test, while preserving every kind, relation, use, and action-changing detail. Keep ordinary pattern-use wording ordinary; open a deeper FPF route only for a genuinely unresolved value. - Check that recognition, first action, and first useful result still precede optional modeling, evidence, conformance, and assurance work.
F.19is the common semantic pass over the changed span;E.10is a cue and an exact route for residual FPF wording, not a second normal-pass algorithm. - For every changed public or consumed interface—entry wording, input or result, field or position meaning, action order, stop, return, or reconsideration condition—repair each determinate stale ToC or README cue, example, relation, and true direct consumer in the same authoring increment. Find consumers by the meaning they teach or use; a shared word, identifier, or nearby reference is not enough.
Earlier-edition and candidate-only uses remain different bases, and both may be present in one revision. Compare that exact earlier edition with the candidate edition. An earlier-edition use keeps its earlier-edition basis and one of the four classifications above; a candidate-only use keeps its exact accepted basis. Do not classify a candidate-only use as an earlier-edition use or invent history for it. Treat a selected use as required when its loss changes action or boundary, and as optional when it demonstrates breadth only. Backward compatibility alone is not improvement, and a candidate-only promise is not improvement until the text supports its executable use. Use desk replay by default and escalate to a cold reader, AI-agent, or observed-work check only when ambiguity or consequence justifies it. If later independent review needs a recoverable note, use the smallest existing authoring source; do not create a card, score, universal schema, or one written row per idea.
Test first-use affordability by checking whether the positive Solution supports this short rendering:
This rendering explains the pattern; it does not claim that actual work is linear. Use an optional local mantra only when it improves recall, and show one ordinary traversal only when several rows materially improve explanation; choose the smallest form that keeps the action, result, and boundary recoverable. Explanatory rows may fade as competence or task demand permits, but an independently action-changing condition or boundary may not. If the traversal itself must be a durable governed object, use the exact published DemonstrativeUnfoldingSlice@Context designation only after [A.22.CGUS](/generated/patterns/A.22.CGUS) admits that structure for the named pattern use. Put a subject-side check immediately before the continuation it changes, and keep authoring, review, quality, and release checks outside the subject Solution.
Resolve authoring lists with [F.19](/generated/patterns/F.19). When a list can change pattern use, apply the same connected [F.19](/generated/patterns/F.19) reading used for prose. [E.8](/generated/patterns/E.8) keeps only the authoring effect: put the practitioner's proposition or action before illustrative material; declare a genuinely normative closed set as closed under its governing rule; signal examples as non-exhaustive when a plausible reader could mistake them for a classification; and do not let a noun series or catalogue replace the Solution.
Do not add a second enumeration taxonomy or a per-member result form. [E.10](/generated/patterns/E.10) may cue a suspicious head or series, [F.19](/generated/patterns/F.19) decides its membership semantics and discourse load, and an exact subject pattern settles any unresolved kind, relation, or normative set.
Decide Whether a Narrower Contribution Changes Practice
Use this when a broader available contribution and a proposed narrower contribution both appear to answer the same recognizable working situation. State the intended reader, use, and scope. Apply both contributions at comparable effort and find the first difference in what the reader notices or decides, does, needs or checks, obtains, or uses as a stop, return, or retry. A narrower title, domain noun, paraphrase, or extra example is not enough by itself. If no action-changing difference remains, omit or merge the narrower text and point to what already answers the situation. If the two contributions address different situations, state that boundary before deciding their relation.
An action-changing difference shows that the contribution is distinct; it does not show that the contribution is worth keeping. Retain or merge it only when the changed action, result, boundary, or saved source reconstruction is warranted and useful for the declared reader, use, and scope under the applicable domain, evidence, currentness, affordability, and architecture checks. Use only the checks that can change this decision. Repair or reject a distinct contribution that is wrong, stale, unsafe, unsupported, incompatible, or needlessly burdensome. Keep an explicit gap when no acceptable contribution answers the situation.
Naming a dependency does not settle the comparison. Say which available result supplies the reusable part, what kind of result it is, which product and edition or current state supplies it, how the reader uses it, and which currentness or availability condition can change that use. State maintenance separately only when it changes the receiving use. Then preserve any remaining domain problem, filling, constraint, relation, evidence limit, return, or discovery need without copying the general rule.
When reuse or a gap closes the reader's question, state which of these is actually true:
- Use an available result. Name the result, what kind of result it is, the product and edition or current state that supplies it, the receiving use, and any currentness or availability condition that can change that use. The supplying product may be an FPF, DPF, LPF, or a separate non-framework product. If maintenance changes the use, state its separately established relation and evidence.
- Use a MethodDescription. Name the public description, the Method it describes, and how the reader uses the description to select or perform that Method. State availability, currentness, or a separately established maintenance fact only when it changes that use. Do not report the expected result as already obtained.
- Use a direct source as evidence. Name the source, the claim or decision it supports, the receiving use, its limits, and a usable locator. Source availability is not result production.
- State a named unavailable result. Name what is missing, the action or decision it blocks, the missing condition, and the observable condition for retry.
For example, "feed the animals" may be true for both a mouse and a tiger yet fail to tell the feeder what food to give. Grain and meat change the action, so keep or link the animal-specific guidance when that difference is warranted for the declared use.
By contrast, a pump-maintenance restatement of an available evidence-use contribution adds nothing if it changes only pump nouns and one example. Omit or merge the restatement, point to the maintained result that already answers the situation, and judge any promised maintenance-framework coverage separately.
A tiger-feeding proposal may instead require manager approval and a laboratory certificate before every ordinary feeding. That proposal changes the feeder's action, but if no safety rule, evidence limit, law, or observed failure warrants the burden for the declared use, reject it or repair it to the smallest warranted check. Distinctness alone does not preserve it.
A result maintained outside the receiving framework may answer the reader's use without becoming part of that framework. In a package-coverage account, count that external result only when the exact result and supplying product, receiving use, practical discovery route, and any material currentness or availability condition are explicit, and say that the result remains external. Otherwise keep the promised family as a gap or omission. When the resulting stable pattern set materially changes a promised problem family, obtain a current E.4.DPF.DA D12DomainProblemFamilyCoverageAdequacy result for the resulting exact DPF or LPF edition. Reuse a matching current result when the exact edition, promised families, declared use, relied-on results, and relevant conditions did not change; do not record proof that a revisit happened.
Carry the content functions across Method-description scales
Use the twelve substantive functions in the canonical template as authoring questions for a whole FPF, DPF, or LPF and each selected substantive profile. E.11.PFP:4.7 governs their public answers, inheritance, and placement in the framework's publication units. The same functions can describe a broad Method, a composition of Methods, or a narrower use; the declared subject and applicability determine the scale.
The Solution explains the actual organization and use of the described Methods: their contributions, relations, and the results that make a next move possible. Architectural Rationale explains why that organization and those choices serve the declared use, which serious alternatives were considered, their trade-offs, and the conditions under which another choice becomes preferable. Preserve shared source explanations there when users need them to understand or adapt several patterns together.
The pattern heading, header block, section grammar, and footer apply to each individually declared pattern. The whole-framework account uses the publication form in E.11.PFP; its content questions do not turn every publication unit or intermediate group into another pattern. Its Preface subsection headings identify the framework, publication unit and ordinal path through E.11.PFP:4.7.1, so an isolated excerpt remains locatable without being classified as a pattern body. Keep generality, specialization, Method composition, reuse, bounded-use projection, and publication grouping explicit under E.8:4.2.2. There is no prescribed maximum depth or exclusive-parent rule.
Stylistic Principles (S-0 … S-19)
Authors use the principles as a scaffold, not a straitjacket: the goal is coherent, engaging insight. Engagement remains subordinate to semantic discipline: hooks, quotable lines, Plain restatements, and didactic images may improve recognition, but any ontological, evidence, causal, assurance, bridge, gate, work, decision, or admissibility claim kind or admissible-use boundary they carry must be recoverable through the governed Tech reading or named neighboring pattern. Ordinary Plain prose without that claim kind or admissible-use boundary stays ordinary prose.
S-0 (Governing-claim flow) — explanation
Open with the recognisable working situation and the claim or action that governs the passage. Add history, related patterns, examples, imagery, or a recall line only when it helps the intended reader understand or use that claim. A prerequisite may come first when the reader needs it to interpret the claim or act safely. Apply F.19 when atmosphere, coordination, or rhetorical scaffolding delays the governing message.
Recognition text and assurance text
Every canonical pattern SHALL stabilise one primary EntityOfConcern, relation record, or claim record early enough that a cold reader can tell what kind of thing the pattern is actually governing. If ordinary forms vary (note, sheet, guided UI, rendering, review aid), the text must make explicit which of those are merely presentation forms of one primary selected EntityOfConcern, relation, or claim and which would instead name a different act, process, work-result record, or governing companion. Recognition and assurance texts may refine that selected item differently, but they must not silently swap the central kind.
If a pattern uses a broad umbrella or head together with a narrower operative branch, the text must also make the stack explicit early enough for first reading: what the broad head names, what the current narrowed branch is, what primary EntityOfConcern, relation record, or claim record is actually in play, what exact action assertion and predicate are current, and what wider work or process remains outside the pattern. A qualifier alone does not restore that stack.
Under F.18 local-first naming, the canonical pair here is recognition text and assurance text.
The earlier provisional recognition shell and assurance shell wording is retired.
These names refer to two reading-order functions carried by existing sections or projections inside one pattern; they do not mint new authoritySourceRef targets, generic neighboring-pattern relations, publication-form or face kinds, publication-face kinds, or a second face family.
A third didactic-content function remains optional and is justified only when the family is especially easy to misuse, easy to over-read, or hard to teach without extra scaffolding.
The recognition text is the first-reading text.
It is the part of the pattern that lets a cold working reader recognise the situation quickly enough to decide whether to keep reading.
It should start from a subject-domain or practice moment before internal taxonomy whenever the pattern is meant to help real work rather than only internal canon maintenance.
In practice it usually appears in an early Use this when line or equivalent opening, plus the upper parts of Problem frame, Problem, Solution, Consequences, and nearby worked slices.
Its job is to make visible:
- what ordinary working situation this pattern is for;
- what goes wrong if the pattern is missed;
- what the pattern buys the reader in practice;
- when this is not the right pattern;
- what primary
EntityOfConcern, relation record, or claim record is actually being kept stable; - and, when technical terms must appear early, a pairwise plain gloss for each early FPF-governed technical term.
The assurance text is the second-reading text. It carries the heavier FPF-governed material that makes the pattern reviewable and auditable:
- declaration blocks and typed fields when those are part of the pattern's declared conformance or boundary claim;
- representation ontology, EntityOfConcern discipline, or primary-EntityOfConcern discipline;
- any minimal modeling or mathematical lens that keeps the primary
EntityOfConcern, relation record, or claim record stable; - guidance or check material, invariants, admissibility, and stop or neighbouring-pattern conditions;
SoTA-Echoingwhen it carries explanatory work;- and the review hooks that let a broader or more consequential interpretation or use be checked explicitly.
The assurance text may sharpen, justify, and discipline the recognition text. It must not silently replace, strengthen, or universalize the claim that the recognition text made visible. If the recognition text says “this pattern helps with a bounded working situation”, the assurance text must not quietly turn that into an unbacked carrier claim, unbacked guarantee, or broader universality claim.
If a pattern claims universal or transdisciplinary status, that claim must already be visible in the recognition text.
It is not enough for universality to appear only later in a guidance or check sheet, declaration block, or SoTA-Echoing rationale.
A broad claim should therefore be demonstrated in the recognition text through heterogeneous reader or domain situations adequate to the claimed breadth. The separate three-domain minimum in A.8 applies to universal-core U-kind admission.
When a compact matrix helps, F.16 is the preferred template for showing that breadth.
If SoTA-Echoing carries an FPF-governed claim, the practical implication of those rows should be recoverable from the recognition text and case bank rather than remaining a late-only justification layer.
A third didactic-content function means enough didactic and operational content that the pattern survives without nearby project documents. Typical indicators include:
- at least one concrete source and resulting-publication slice in Archetypal Grounding when the pattern defines or constrains transforms or publication change;
- at least one boundary-heavy example or anti-example when nearby or companion patterns are easy to confuse;
- reviewer guidance that tells what to inspect first and which neighboring FPF pattern defines or constrains the failure mode and which project-side FPF kind and reference named by value carries the claim or effect;
- local mini-definitions or glossary material for recurring terms that would otherwise be recovered only from project context.
Pattern density is therefore not “more metadata” and not “longer tag lists”. It is the presence of enough recognition, assurance, and, when needed, extra didactic material that a reader can understand the pattern, apply it lightly in ordinary cases, and recognise when a heavier review profile is required.
Package-form and neighboring-pattern reference discipline
FPF package-form words and neighbouring-pattern references carry stable meanings. State the actual relation used by the sentence, and use the exact subject pattern when that relation is not recoverable from ordinary wording.
For an ordinary neighbouring-pattern reference, state the concrete contribution and cite the PatternID. An identifier or locator only helps the reader find that content. Identify an exact claim-bearing episteme, ClaimGraph, edition, or relation assertion only when a named later use depends on that identity.
A local ...PatternLocator field may remain where an existing schema already uses it as a non-semantic convenience, but ordinary prose and entry cues do not require one. It never substitutes for the cited content's concrete contribution or, when the stronger identity branch is active, for the exact claim-bearing content. Changing only a locator without changing what it resolves is a representation change; changing the defining content or exact assertion may reopen the semantic object whose receiving use depends on it.
Keep the following package and relation words distinct:
- pattern reference = an ordinary citation to content whose concrete contribution is stated in the current sentence;
- specialization = an exact relation in which the child carries the required parent content plus an explicit child delta and use boundary;
- overlay = a cross-cutting reading or review projection over stated source content; it adds no authority or obtaining relation by name;
- profile = a declarative bounded-use or review projection from stated source content, not a replacement pattern or actor;
- family = a recurring class of cases under an explicit membership rule, not a hidden common owner;
- bundle = a packaged set of defaults, allowances, or coordinated members whose actual relations remain explicit;
- cluster = a navigation or reading-order grouping, with no semantic relation by grouping alone;
- suite = a coordinated set whose suite-level membership and coordination semantics are explicitly stated;
- pack = an editorial, source, review, or delivery grouping, not semantic authority;
- kit = a reusable coordinated publication or boundary-description package with exact kit-level membership and use;
- record = a case, report, assertion, representation, or review record under its own identity;
- umbrella = a provisional review head spanning possible subfamilies before an exact membership rule and the relevant claims and relations are settled.
These words are not interchangeable and do not stand in for a missing relation. Say specialization of … with delta …, profile projecting … for use …, overlay reading …, bundle containing … under membership rule …, or another exact formulation. A source-defined position name may be reused when the cited content defines that position and the current assertion uses it in that sense; otherwise recover the meaning through E.10.ROLE and do not improvise near-synonyms for stylistic variety. The preceding receiving-use discriminator decides whether exact claim-bearing content must also be identified.
Precision-restoration placement discipline
When a pattern or companion text is drafted from E.10 or E.10.ARCH, distinguish three authoring objects:
semanticAreais the Part-F semantic unit for a wording-use restoration row: one Concept-Set row, one UTS row, or an explicitly bounded row-set. It is declared withsemanticAreaBaseConceptandsemanticAreaSenseFamily.ontologicalNeighborhoodis the applicability neighborhood around that namedsemanticArea: nearby primaryEntityOfConcernkinds, relation kinds, claim records, content that defines or constrains the current use, non-use boundaries, and remaining reader use that can carry the recovered meaning after the wording is repaired.pattern nestis the publication and specialization placement of a pattern under a declared family or membership relation.
These are not synonyms. A precision-restoration pattern is placed in the pattern nest whose primary EntityOfConcern, relation record, or claim record it repairs. Its semanticArea states the Part-F semantic unit it repairs, while its ontologicalNeighborhood may name several direct relations and pattern content that defines or constrains the asserted uses. For example, quality-term repair lives in the C.16 characterization nest, even though its neighbouring relations can include relation construction, action invitation, evidence, assurance, source-use assignment, engineering quality bundles, pattern-quality evaluation, or mathematical-lens use.
Affected patterns should use a thin pointer when the first-stage wording repair belongs elsewhere. The pointer names the selected restoration pattern and the condition that triggers it; it does not copy the trigger registry, the full E.10.ARCH recovery algorithm, or a second local architecture for the same repair. The affected pattern then keeps its own subject matter: the characteristic, structure, view, episteme, relation, evidence, assurance, gate, work, decision, or adequacy question it already governs.
If a draft proposes a new precision-restoration pattern, the authoring claim must show the repeated wording failure, semanticAreaBaseConcept, semanticArea, semanticAreaSenseFamily, the recovered primary EntityOfConcern kind or relation/claim record, the intended pattern nest, the neighboring governing relations, and the admissible action left after repair. A new pattern is not justified merely because a word appears often, because a local checklist wants a bucket, or because a campaign needs a tidy grouping.
Intended-reader discipline for pattern prose
A pattern is written for its intended framework user: the person who uses it to organise thought, investigate a question, change a system, publish a description, or review a result under that pattern.
Its sections explain the described subject, the user's action and result, costs, and grounded boundaries that change use. Public architectural explanation belongs here when it helps the reader understand, select, combine, or adapt the Methods. For example, explain why a profile specializes one step but reuses another, how a combination makes its next result possible, or when a serious alternative would be better. State the actual relations in Solution and their reasons in Architectural Rationale. A whole language and its profiles use the same content functions through E.11.PFP:4.7.
E.8 reader and reviewer wording is framework-authoring wording. Project-side publication readers, explanation readers, comparative review units, and participants in named project-side review relations are governed by the patterns that name those units and relations, such as E.17, E.17.ID.CR, E.17.EFP, A.10, A.15.4, A.20, or A.21.
Keep the development history of the current pattern version in its DRR, companion, review, or release material. This includes current arguments for promoting a draft, authority-reference or naming freezes, merge and landing state, and review correspondence. When a development decision contains a durable reason that changes practitioner use, publish that reason with the necessary explanation and source return; retain the dated decision and its evidence in the development record. Users need enough reasoning to understand the choice without reconstructing that record.
Human-facing fit beyond intended-reader correctness
Human-facing fit is also subject-domain fit. A recognition text that starts from internal taxonomy, pattern-placement convenience, or package-architecture wording before the problem-domain moment is still under-authored even if its later guidance or check text is correct. When a broader umbrella name and a narrower operative branch are both used, the recognition text should also tell the reader which stack is actually active rather than leaving that reconstruction to a later declaration block or companion note.
A pattern can already address the intended reader and keep its boundaries clean, yet still fail the first minute of use for a cold working reader.
That failure usually appears when the text is admissible but does not yet make the working situation, practical payoff, primary EntityOfConcern, non-use boundary, or first action-guiding move visible enough.
P-2 epistemic precision check. When the E.10 criteria call for epistemic precision restoration in pattern prose, the first admissible action-guiding move must survive as remaining admissible reader use or be replaced by a neighboring FPF rule whose content now defines or constrains that claim application. This is a direct E.2 P-2 and E.12 requirement, not an optional style preference. Intentional didactic metaphors and vivid Plain recognition lines are admissible when they are ordinary recognition aids or when their claim kind or admissible-use boundary maps back to Tech under E.10:6.2. A precision-corrected rewrite that leaves the recognition text inert is still under-authored.
For canonical patterns, the first-reading text should behave as a recognition text and the heavier review/check scope should remain in an assurance text.
When a pattern claims practice guidance or is meant to be used by engineers, managers, researchers, or other working readers, authors should make the following visible before the heavier harness takes over:
- a recognisable
Use this whenor equivalent first-minute recognition cue; - a concrete working situation in
Problem frame, not only taxonomic or pattern-placement language; - a short statement of what goes wrong if the pattern is missed or misread;
- a short statement of what this pattern buys the reader in practice;
- the first admissible action-guiding move the user should take in that situation;
- a short
Not this pattern whenboundary for ordinary nearby non-use cases; - one minimally viable worked case or use slice that shows what changes in practice;
- when a typed declaration block, formal lens, or other compact modeling material is FPF-governed, a short user-facing statement of what kind of object the pattern is governing and what minimal lens keeps that object reviewable;
- pairwise plain glosses for any FPF-governed technical terms that must appear before the heavier declaration content arrives;
- when
SoTA-Echoingcarries explanatory work, a short working-reader implication for each row or cluster of rows and a visible link back to the case bank or worked slices that those rows discipline; - a visible split between the recognition text and the heavier assurance text or companion material;
- and, if the draft implicitly serves several working-reader situations, an explicit primary working reader, primary concern, or primary viewpoint.
Problem-frame recognition signature (informative). A canonical pattern should
expose the working situation through its Problem frame, not through one
separate navigation block. When an E.11 pattern-entry discoverability problem
is present, the same Problem frame may also carry candidate-pattern and
tempting-wrong-pattern cues; otherwise it should stay with action guidance
rather than becoming a local catalogue row.
The local recognition signature should make recoverable:
- the concrete working situation;
- the primary
EntityOfConcern, relation named by value, claim record, or stabilized concern; - what goes wrong if the pattern is missed or misread;
- the first admissible action-guiding move and what that move buys;
- the ordinary not-this-pattern boundary;
- the first admissible action-guiding result; when an
E.11discoverability problem is present, the first admissible entry stop or entry-stabilizing result.
Use this pattern when, This pattern applies when, or equivalent Problem frame prose may be used as the first sentence or compact cue of this
signature.
It is not one separate required section.
Entry-cue authoring rule. Begin with one ordinary question about the user's object and claim, before any PatternID, card, template label, or internal taxonomy. In the same compact cue, state what cited content contributes, cite the pattern id, and name the smallest result usable now plus its stop or return condition. Add a tempting overread only when the F.19 plausible-reader test finds independent local ground and an action-changing effect. Name an exact episteme, ClaimGraph, or edition only when a later use depends on that identity. The cue guides reading; it does not by itself constitute a result or relation.
Resolve the current head and relation under the exact subject pattern before coarsening. In an ordinary cue, state that pattern's concrete contribution and cite its id; identify exact claim-bearing content only when its identity changes the receiving use. Preserve every live status distinction defined by the subject pattern. A cue or representation supports only the object, status, or relation admitted by its governing pattern.
Compact candidate-pattern comparison belongs in E.11-distributed entry material; expanded entry-disambiguation cases belong in I.2.
If the prose points to neighbouring patterns or companion content, state whether that content defines a kind, constrains a relation, supplies a test or method, provides a project-side FPF kind and reference named by value, or supplies an E.11 entry-recognition reclassification; do not present a citation as a hidden co-authority of the current pattern.
If the pattern claims broad, universal, or transdisciplinary usefulness, that breadth should already be visible in the recognition text.
The recognition text should show heterogeneous reader or domain situations adequate to the claimed breadth, rather than one narrow case family with a later broad claim attached.
When a compact matrix helps, F.16 is the preferred template for making that breadth legible.
This is not a request to flatten the pattern into plain language only. It is a rule about ordering, assurance depth, and text consistency: the recognition text must help a working reader recognise the pattern early, while the assurance text continues to carry the full claim kind or admissible-use boundary. If the pattern uses technical lexicon, ontological distinctions, or a mathematical lens, those structures must remain recoverable, but the first-reading text should not require the reader to decode that full stack before recognising the working situation. The assurance text may tighten or discipline the recognition text; it must not silently shift what the recognition text claimed.
Illustrative migration example (informative).
Old pre-template top:
Repaired Problem-frame recognition signature:
Design-time and run-time referents stay separated in pattern prose
Pattern prose must keep its referent index explicit. In ordinary body sections, the default truth-makers are run-time or governed-domain objects, states, moves, boundaries, consequences, and user-facing practical effects. Normative-standard wording is still admissible when the sentence is explicitly about the standard as a normative publication, for example in marked migration navigation examples, marked informative notes, or conformance/checklist clauses.
Design-time and development-state referents are different objects. The current draft, current body, current pass, author, reviewer, handoff, packet, governing companion, landing choice, or other writing-process objects must not be smuggled in as the hidden truth-condition of pattern prose. A quick test is: what makes this sentence true? If the sentence is true because the current text is arranged a certain way, because the author or reviewer must do something next, or because the current development state says so, then it is design-time residue, not pattern content.
Move that material to the authored-slice carrier, handoff, DRR, or companion architecture note. If a sentence is kept in the pattern, rewrite it so that its truth depends on the governed run-time/domain object or on the standard's declared normative claim set rather than on the current writing pass.
If a pattern or example claims autonomy, name the admitted U.System whose freedom of action is being evaluated and use the current E.16 pattern that defines or tests the claim. Add another relation only when it is current under its own governing pattern. Admit dated Work under the A.13-first and independent A.15.1 rule in E.8:0.3, adding F.6 only for current assignment-bound attribution. Add autonomy apparatus or a vignette only when it helps the reader use that claim. Apply F.19 after recovery; if the corpus supplies no direct governor, return A.6.RCD missing-governor.
Archetypal Grounding (System and Episteme)
Note: Prefer examples that reuse FPF characteristics vocabulary (e.g., F (Formality) rather than “F‑score”) unless you explicitly mean an external metric and name it as such.
Bias-Annotation
Lenses: Gov, Arch, Onto/Epist, Prag, Did. Scope: Universal for the authoring conventions in this pattern. This guidance biases toward Did (readability, narrative flow) and Arch (template regularity) by design; the mitigation is content-bearing reduced sections and justification through the smallest grounding, misuse, boundary, or reduced-case statement, not omission placeholders.
Conformance Checklist
CC style (canonical).
Conformance Checklist items are authoring checks: they test whether the pattern guidance has been applied and written correctly in a pattern or companion text that claims conformance. They do not replace Solution, do not make the pattern a control form, and do not state deontic obligations about the modeled world. A CC clause of the form “X SHALL …” is to be read as “In a conforming pattern or companion text, X SHALL …”.
Preferred wording for new or edited CC items: start with an explicit conformance subject (e.g., “Authors …”, “Reviewers …”, “A conforming implementation …”, “A validator …”). If a CC item is enforcing an admissibility predicate, it SHOULD cite the predicate’s identifier (from a Definition: / Invariant: / Well-formedness constraint: block) rather than restating the predicate as “X MUST …”. For boundary/interface/protocol/declaration patterns, prefer A.6.B-scoped claim IDs (L/A/D/E) or cite an existing Claim Register (A.6.B:7) instead of restating mixed prose.
Common Anti-Patterns and How to Avoid Them
These failure modes recur in drafts and in downstream application. They are predictable ways the Forces in this pattern get violated.
Consequences
Architectural Rationale
Structure and style function as FPF’s grammar. By unifying what were once separate “template” and “style guide” patterns, authors face a single reference point that satisfies:
- P‑1 Cognitive Elegance – uniform, minimal surprises.
- P‑2 Didactic Primacy – narrative flow, dual archetype examples.
- Guard‑Rails 1 & 2 – no tool jargon, no notation lock‑in inside prose.
A unified template also improves retrieval: a chunk containing A.2:<n> - Bias‑Annotation remains self‑identifying even when parent headings are missing, and the required footer marker makes truncation detectable.
The ASCII - separator in H-2 keeps heading entry inexpensive: authors can type it directly on ordinary keyboards, and readers can reuse the same characters in search and plain-text tools. Typographic dash variants require an extra input or conversion step while adding no information to the boundary between an identifier and its title. Where a prose dash is useful, -- is a keyboard-accessible option; the identifier/title separator remains -.
International and industry standards often speak in terms of conformance criteria. FPF uses the label Conformance Checklist to make adoption easier for engineers and managers.
SoTA-Echoing (normative; typed comparison to contemporary best-known practice)
Canonical definition and contract. This is the FPF definition of SoTA: the best-known currently defensible answer to one named practice question. F.1 may prepare the question-relative source cut and E.21 may evaluate the resulting pattern, but neither redefines SoTA. A SoTA-Echoing section earns its place by changing the pattern's Solution, boundary, case, check, relation, evidence requirement, stop, or reopen condition. It is not a bibliography, source-currentness register, or lineage shelf.
Source roles in plain wording. Classify each retained source by what it can do for the question:
- a best-known-line candidate supplies or critically synthesizes the strongest current answer being considered;
- a serious current rival supplies another answer that could change the selection;
- failure or counterexample evidence shows where an answer breaks or does not transfer;
- an official or popular comparator exposes a default worth comparing but gains no rank from authority or adoption;
- lineage only explains history without supporting the current selection; and
- identity/currentness only identifies a source, edition, date, or maintenance state without supporting its truth, adequacy, or rank.
Only the best-known line, serious rivals, failure evidence, and a necessary explicit comparator belong in SoTA-Echoing. These are comparison roles, not publisher or institution classes. An official standard, widely used practice, or university-endorsed line can be the best-known-line candidate when its substantive answer wins the comparison, but authority, freshness, prevalence, or praise contributes nothing to that win. Lineage-only and identity/currentness-only material stays in source records, notes, or evidence carriers outside the pattern body. An official or popular default stays as comparator only when its precise defect is needed to explain the selected answer and changes a governed pattern locus.
Positive comparison contract. Every positive SoTA use states, in readable prose or one compact table:
practiceQuestion— the exact working question;bestKnownLine— the selected answer, not merely its newest source;seriousAlternativeOrDefault— the rival or default that could have changed the answer;defectOvercome— the action-changing defect, limit, or trade-off that selection repairs;patternMutation— the exact Solution, boundary, case, check, relation, evidence, stop, or reopen locus changed;sourceRolesAndLimits— the exact source edition or stable locator, why it has this comparison role, and what it does not establish; source identity supports replay, not rank; andreopenCondition— the smallest new evidence, rival, failure, or use change that would require comparison again.
Mark material moves adopt, adapt, or reject. Explain which defect of the incumbent, popular, or official answer is repaired and why the selected line is no worse at comparable application effort on the values that matter and better on at least one, or state the trade-off deliberately accepted. More sources, a later date, a wider deployment, institutional praise, or a longer review cannot replace that comparison.
Honest gap and lightest sufficient evidence. If an adequate best-known comparison cannot be established, say which rival, counterexample, or source role is missing and return that source gap. Do not fill the section with a current standard or recent paper. Use F.1 for the smallest question-relative cut and its SoTA-specific role branch. Use F.0.2 only when the conclusion actually needs cross-source synthesis. Use a broader G.2 pack only when repeated refresh or a wider claim justifies that cost.
Evidence and relation discipline. Reuse an existing G.2 pack's exact ClaimSheet, corpus-ledger, Bridge rows, and source roles instead of forking a second narrative. Inherit non-conflicting comparison content from an accepted DRR and its source materials while keeping the DRR as the decision and placement record. For an obtaining semantic Bridge, identify the two exact F.17 local senses, the F.9 relation, and a separate bounded-use claim; otherwise leave that relation unasserted. Keep numeric comparison under its applicable ComparatorSet or CG-Spec without hidden scalarization.
Writing guidance. Lead each row with the practice question and practical choice. Name the selected line and serious alternative, state the defect and pattern change, then give source roles, limits, and reopen condition. Complete sentences are preferred to tag lists. External terminology or tooling stays out unless the comparison itself needs it.
SoTA alignment for this pattern (E.8 self-echo)
Relations
-
Coordinates with:
E.9.DAwhen an authored pattern body is drafted from a concreteDRRand the blocker is whether theDRRselected, distributed, carried source use, carried accepted decisions, or supplied a first drafting action sufficiently for that authoring use.E.8still governs the pattern body;E.9.DAis not a mandatory authoring section, review card, or substitute for writing the Solution. -
Constrained by: Guard‑Rails E.5.1–E.5.4 (lexical firewall, notation independence, etc.)
-
Coordinates with:
E.21when one authored FPF pattern version is evaluated as a scoped pattern-quality claim.E.8governs authoring shape, recognition text, action guidance, worked cases, SoTA grounding, and conformance material;E.21governs the pattern-quality evaluation, required coordinate values,PatternQualityStatus, and stop condition. Do not importE.21as a mandatory authoring section or full review card. -
Coordinates with:
E.23when an authored FPF pattern body is being improved through repeated passes.E.8still governs the authored pattern body;E.23governs the repeated quality-improvement method; the object-under-improvement evaluation such asE.21orE.9.DAsupplies value meanings and stop meanings. -
Coordinates with:
E.13when an authored pattern claims practical payoff or uses a visible quality value, metric, checklist result, review result, or release posture as if it were the intended value.E.8keeps the payoff in user-facing prose;E.13repairs proxy-to-value substitution. -
Coordinates with:
E.4.DPFfor choosing a DPF reference code, PatternID plan, continuity across editions, and reader return after split, merge, replacement, or retirement; andE.11.PFPfor current Part, position, public order, and citation display.E.8owns only the common identifier grammar and reference wording; identifier form and checker success decide none of those authoring or publication questions. -
Coordinates with:
E.11.PUR, which supplies the recommended-pattern-use decision for a current concern, andE.10.MOVE, which disambiguates whether move-like wording names pattern-use recommendation, direct work, plan, gate, transformation, publication, source, architecture, call-planning, or language-state material. These references state concrete contributions; an exact assertion, claim-bearing episteme, orClaimGraphis added only when the named receiving use depends on that identity. -
Constrains: All patterns.
E.9defines the DRR decision kernel and decision-inspection content blocks.
E.8:End
Last Updated: 2026-09-10 — upstream FPF commit a87d0ef4 (github.com/ailev/FPF)