agentleFS
gear-foundationgear-foundation/vara-skills/skills/gear-architecture-planner/SKILL.md

gear-architecture-planner

Skill17 starsChanged 7 months agoMITView on GitHub

Use when an approved Gear or Vara spec must be mapped onto program boundaries, services, message flow, and integration surfaces. Do not use when the feature is still undefined or when the task is already reduced to code edits.

We split this skill into the rules it gives an agent

9 rules. About 0 are common, 4 are distinctive, and 5 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 5

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Read ../../references/vara-domain-overview.md, ../../references/sails-cheatsheet.md, …

    line 14
  2. Very specific:

    If the architecture choice depends on what Gear programs can express through gstd, review ../gear-gstd-api-map/SKILL.md before locking the …

    line 16
  3. Very specific:

    Use ../../assets/architecture-template.md as the output shape.

    line 18
  4. Very specific:

    Write the result to docs/plans/YYYY-MM-DD-<topic>-architecture.md.

    line 20
  5. Very specific:

    Keep #[program] thin and push business logic into services.

    line 32
  6. Distinctive:

    Treat generated clients or equivalent Sails Header-aware encoding as the default Sails message contract.

    line 34
  7. Distinctive:

    Treat actor boundaries and async flow as design constraints.

    line 35
  8. Distinctive:

    Call out remote-call failure policy instead of leaving it implicit.

    line 36
  9. Distinctive:

    Do not collapse architecture into a file-by-file coding checklist.

    line 37

≈ “Common” is an estimate: at least 1 in 5 of the 308,232 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

Gear Architecture Planner

Overview

Turn an approved spec into a concrete Gear/Sails architecture note.

Start Here

Read ../../references/vara-domain-overview.md, ../../references/sails-cheatsheet.md, ../../references/sails-program-and-service-architecture.md, ../../references/gear-messaging-and-replies.md, and ../../references/sails-idl-client-pipeline.md.

If the architecture choice depends on what Gear programs can express through gstd, review ../gear-gstd-api-map/SKILL.md before locking the design.

Use ../../assets/architecture-template.md as the output shape.

Write the result to docs/plans/YYYY-MM-DD-<topic>-architecture.md.

Workflow

  1. Confirm the spec artifact exists and is approved.
  2. Choose program constructors and service boundaries.
  3. Map state ownership, routing, messages, replies, and events.
  4. Record generated-IDL or generated-client implications.
  5. Capture off-chain components, failure paths, and explicit non-goals.

Guardrails

  • Keep #[program] thin and push business logic into services.
  • Make the constructor shape and storage pattern explicit instead of leaving them to implementation guesswork.
  • Treat generated clients or equivalent Sails Header-aware encoding as the default Sails message contract.
  • Treat actor boundaries and async flow as design constraints.
  • Call out remote-call failure policy instead of leaving it implicit.
  • Do not collapse architecture into a file-by-file coding checklist.

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.