Skip to main content

.faf Examples#

Five .faf files, each a different app type (project.type), arranged as a ladder — from the smallest honest file to the root of a monorepo.

Every score below was produced by running a scorer over the file in this directory. None is written by hand.

The ladder#

Exampleproject.typeActive slotsScore
documentation.fafdocumentation9100 ✪
cli-project.fafcli12100 ✪
chrome-extension.fafextension15100 ✪
n8n-workflow.fafbackend16100 ✪
monorepo-root.fafmonorepo-root19100 ✪

All five score 100. That is the point of the ladder: a documentation repo with nine slots filled is as complete as a monorepo root with nineteen. It is not scored against questions it was never asked.

What each one shows#

documentation.faf — the minimum. Project and human context only. A docs repo has no stack, so twenty-four slots are marked slotignored and never enter the score.

cli-project.faf — adds delivery: hosting, build, CI. A CLI ships and builds somewhere, so those count. No frontend, no database.

chrome-extension.faf — adds the frontend slots. Note ui_library: slotignored among otherwise populated frontend slots: this extension styles its popup directly and uses no component library. Saying so is different from leaving it empty.

n8n-workflow.faf — adds the backend slots. It also shows what a .faf describes: the support bot, not the workflow JSON that defines it. The subject is always the project.

monorepo-root.faf — the twelve slots the others never reach: how packages are organised, what orchestrates the build, how versioning and shared config work. Worth comparing across tools:

Same file, same number.

The mechanism#

The app type (project.type) says which slots a project is asked about. Everything it is not asked about is written into the file as slotignored, which removes it from the denominator:

A slot left out entirely is not the same as one marked slotignored — an absent slot reads as empty and counts against the score. Tooling writes the labels for you; faf auto marks what the type implies.

Memory files#

Two .fafm examples sit alongside these — voice-memory.fafm and knowledge-memory.fafm. Memory is a separate format with its own specification (MEMORY-FORMAT.md) and is not slot-scored.

Write your own#

More#