agentleFS
developzone5developzone5/sanad/skills/spec/SKILL.md

spec

Skill3 starsChanged 21 days agoMITView on GitHub

Create or update a durable, version-controllable spec file for a feature that spans multiple sessions — goal, decisions, plan/checklist, risks, and a running log. Invoked manually with /spec when starting or updating multi-session feature work. One lean file per feature, committed with the code.

168 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use backprop, ios-clean and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • JuliusBrusseeSkill

    backprop

    Bug → spec protocol. When a bug is found or a test fails, trace the cause, decide whether a new §V invariant would catch recurrence, append to §B. This is the one non-obvious thing SDD does that plan-then-execute doesn't. Triggers on test failure, bug report, post-mortem, or explicit user ask.

    Also in 4 projects that use this

  • Saqlain-811Skill

    ios-clean

    Remove the DebugBridge SPM package and all #if DEBUG wiring from an iOS app. (gstack)

    Also in 5 projects that use this

  • Saqlain-811Skill

    ios-fix

    Autonomous iOS bug fixer. (gstack)

    Also in 5 projects that use this

  • bastosSkill

    ios-design-review

    Review iOS app UI/UX design quality using Apple's design principles and the Liquid Glass-era design language from WWDC25/26. Use when asked for a design review, UX critique, visual design assessment, or evaluation of an app's interface quality, design intent, alignment with the new Apple design system, or usability. Triggers: "design review", "UX review", "visual design critique", "review the UI", "does this design work", "evaluate this interface", "design feedback", "Liquid Glass review".

    Also in 5 projects that use this

  • ShreyRaviSkill

    plan-tune

    Self-tuning question sensitivity + developer psychographic for gstack (v1: observational). Review which AskUserQuestion prompts fire across gstack skills, set per-question preferences (never-ask / always-ask / ask-only-for-one-way), inspect the dual-track profile (what you declared vs what your behavior suggests), and enable/disable question tuning. Conversational interface — no CLI syntax required.

    Also in 7 projects that use this

  • timurgaleevSkill

    document-generate

    Generate missing docs for a feature, module or project as tutorials, how-tos, reference and explanation.

    Also in 6 projects that use this

  • +2 more from Saqlain-811

The file

We split this skill into the rules it gives an agent

3 rules. 0 are common, 1 is distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 145 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

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

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

    Write to specs/<feature-slug>.md under the repo root (create specs/ if missing).

    line 15
  2. Very specific:

    If the repo already has a docs/planning convention (docs/specs/, planning/, ADRs), match it instead — check before creating specs/.

    line 16
  3. Distinctive:

    Not a git repo → say so and ask where the spec should live.

    line 17

“Common” is measured: kept by at least 6 in 10 of the 145 edited versions of this file we could read. “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
<!-- Author: Eng. Mohammed Almutairi - Developzone.net -->

/spec — durable feature spec

A spec is a single Markdown file that survives across sessions and is committed alongside the code. It holds the plan and the decisions so neither you nor the user reloads them from memory. One file per feature. Lean — a working plan, not documentation theatre.

Location

  • Write to specs/<feature-slug>.md under the repo root (create specs/ if missing). Slug = kebab-case of the feature name.
  • If the repo already has a docs/planning convention (docs/specs/, planning/, ADRs), match it instead — check before creating specs/.
  • Not a git repo → say so and ask where the spec should live; don't scatter spec files in arbitrary directories.

On invocation

Resolve the target first: glob the specs directory and match the argument (feature name or description) against filenames and titles.

  • No argument → infer the feature from the current conversation; nothing fits → ask.
  • Several plausible matches → list them and ask; don't guess.
  • New feature → create the file from the template, filling Goal + Decisions + Plan from the discussion. Ask the 2-3 questions you genuinely need before the plan is sound; don't guess scope.
  • Existing spec → read it in full first, then make targeted edits — tick checklist items, append to the Log, record new decisions. Never regenerate it from scratch. Past entries stand: a reversed decision gets a NEW Decisions line noting what it supersedes, not an edit of the old one.

Template

# <Feature name>

**Status:** Planning | In progress | In review | Shipped
**Branch:** <feature branch>  •  **Updated:** <UTC date>

## Goal
What we're building and why, in 2-4 sentences. The user-visible outcome.
Out of scope: <what this feature deliberately does NOT do>

## Done means
Checkable lines that define finished (from `/braintrust`'s synthesis, or written before the first commit). `/sanad` Step 3.5 audits coverage per line; `/gate` ticks each with evidence.
- [ ] <observable outcome> — verified by: <test name | request + status | rendered screen>

## Decisions
Decisions made + the option rejected, one line each. (This is what memory can't hold — write decisions down the moment they're made, not at session end.)
- <decision> — chose X over Y because …

## Open questions
Unresolved calls that block or shape the plan. Move to Decisions once answered.
- <question> — waiting on <who/what>

## Plan
Milestones, each a small shippable slice. Tick as done.
- [ ] M1 — <slice> (migration / endpoint / UI / test)
- [ ] M2 — …

## Risks / rollback
- <risk> → <mitigation>
- Rollback: <how to undo; for an applied migration, the expand-contract path>

## Log
One line per session — what moved, what's next.
- <UTC date> — <what happened>; next: <what>

Discipline

  • The spec is the loop's ledger. /braintrust records decisions; implementation records milestones and actual verification evidence before independent review, with status In review. The final review/gate/approval results live in the conversation, saved evidence and PR body. Do not edit tracked bookkeeping after review; a necessary later edit requires review again. Keep log entries to outcomes, not transcripts.
  • Plan to the house rules, don't relitigate them: money = decimal, time = UTC, lists paginated with a stable order, writes atomic, migrations expand-contract.
  • Each milestone should be small enough to pass /gate and /ship on its own.
  • Bump Updated: on every edit. Keep Status: honest — it changes when the work changes state, not when someone remembers.
  • Never put secrets, credentials, tokens, or personal data in a spec — it is committed with the code.
  • The spec rides with the feature's commits: stage it alongside the related code change when the user asks for a commit; don't commit it on its own unasked.
  • Empty section → delete it. If the spec outgrows ~2 screens, prune: collapse shipped milestones, keep the Log to verdicts.
  • Feature shipped → set Status: Shipped and leave the file in place as the record.

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.