agentleFS
fusebase-devfusebase-dev/fusebase-flow/.agents/skills/app-business-docs/SKILL.md

app-business-docs

Skill9 starsChanged 27 days agoMITView on GitHub

Maintain docs/en/business-logic.md in English — human-readable business logic, main user flows, scenarios, and edge cases. Use after domain or workflow code changes, or when revalidating the app during debugging.

The file

We split this skill into the rules it gives an agent

6 rules. About 0 are common, 5 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Keep a single English narrative so humans (and future LLM turns) can understand what the app does and why, without reading every file.

    line 10
  2. Very specific:

    Create docs/en/ if it does not exist.

    line 13
  3. Distinctive:

    Do not treat this as API reference: no exhaustive endpoint lists unless they carry domain meaning.

    line 21
  4. Distinctive:

    Use clear headings, for example:

    line 25
  5. Distinctive:

    If behavior is ambiguous, state the ambiguity and what you verified in code or runtime.

    line 40
  6. Distinctive:

    When revalidating during debug, add a “Debugging notes” subsection with dated bullets if it helps (optional).

    line 46

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

App business logic documentation (English)

Purpose

Keep a single English narrative so humans (and future LLM turns) can understand what the app does and why, without reading every file.

Canonical file: docs/en/business-logic.md
Create docs/en/ if it does not exist.

When to use this skill

  1. After business-logic changes — routes, validation, state machines, permissions, multi-step flows, integrations, or copy that reflects real rules.
  2. Revalidation — the user asks to refresh the doc from the codebase, or debugging shows the doc (or mental model) is wrong or stale.
  3. Onboarding — initial fill after an app or app reaches a coherent shape.

Do not treat this as API reference: no exhaustive endpoint lists unless they carry domain meaning. Prefer flows, invariants, and “if user does X then Y”.

Document structure (adapt as needed)

Use clear headings, for example:

  • Product overview — who uses it, primary job-to-be-done.
  • Glossary — domain terms.
  • Actors & roles — visitor, member, admin, system, etc., aligned with real authz.
  • Main scenarios — numbered happy paths (step-by-step).
  • Edge cases & failure behavior — errors, empty states, retries, idempotency.
  • Data & ownership — what lives in dashboards vs Gate vs isolated stores (if any), at a conceptual level.
  • Code map — short table: scenario or area → primary paths (apps/..., backend/...).

Workflow

  1. Read the current docs/en/business-logic.md if present.
  2. Inspect the code that implements the changed or unclear behavior (apps, backend/, shared libs).
  3. Update the doc so it matches observable behavior, not intentions that are not implemented.
  4. If behavior is ambiguous, state the ambiguity and what you verified in code or runtime.

Quality bar

  • Short paragraphs, concrete examples, no filler.
  • A new teammate should follow main scenarios without opening the repo.
  • When revalidating during debug, add a “Debugging notes” subsection with dated bullets if it helps (optional).

Flag

This skill is copied into the project only when the global CLI flag app-business-docs is enabled (fusebase config set-flag app-business-docs then fusebase update --skip-mcp --skip-deps --skip-cli-update --skip-commit).

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.