How to Use This Repository

Preface node heading:how-to-use-this-repository:1006

What this page is

This is generated FPF reference text from the specification preface or supporting sections. It helps interpret FPF; it is not FPF Reference product documentation.

Methodology

Use it to understand how the specification wants to be read, then return to a route, pattern, or work packet for active work. Cite generated IDs only when the wording changes the task decision.

Content

Begin with what you need from the Library. If you know the method and want its section, use the Table of Contents. If a displayed example resembles your situation, compare the decision its method helps someone make with yours. Whose choice is it? Does the answer concern one contribution, or how several form a result? A direct method or the argument in the example can settle your question. When it supplies a part, carry that result into the remaining work. A cross-pattern card helps when you need to keep several contributions connected. If you are exploring, an example can also suggest a question worth pursuing.

Use the Architectural Reference for the cross-cutting ideas. Big FPF Storylines follows a report-review question through measurement, assurance, a shared-capacity condition and further inquiry. The Architectural Rationale there explains the choice of direct patterns, combinations and profiles and the contributions and limits of their shared sources.

For one selected pattern, read its Solution. Use E.11.PUA to follow it to an answer or identify what is missing. Name a receiving use only if there is a continuation or later reliance to account for. Use E.11.PUR when the question concerns applicability, recommendation, coordination or ordering among possible uses, or when an earlier result may already answer it. An ordinary reversible judgement can stay conversational. Make it addressable only if a named later use needs that support.

If you use an AI assistant, attach or index FPF-Spec.md and ask for plain-language project help first. Let internal pattern names enter only when they make the answer more precise.

A good first prompt is:

You have the FPF specification as a file.
Help me with this current project question:
[short project description and question]

Use plain language for engineer-managers. The Readme examples are clues,
not a list of the questions FPF allows. If one direct pattern can answer
the difficulty, start there. If the answer needs several pattern
contributions, give me a short attention map and open only the
contributions whose questions are current.

First give one useful result for the situation, or a specific blocker.
Then name the project question that result answers and any missing fact,
rule, evidence, or authority needed before a truthful answer is possible.
Add PatternIDs after the plain explanation so I can inspect the direct
Solutions and checks. Stop when the current question is answered; do not
turn the example or card into a whole-project plan.

Last Updated: 2026-11-22 — upstream FPF commit 7a93d8f8 (github.com/ailev/FPF)