agentleFS
thedigitalorganizerthedigitalorganizer/soloship/skills/spec/SKILL.md

spec

Skill0 starsChanged 4 months agoMITView on GitHub

Lightweight formal specification with acceptance criteria. For features that need explicit success conditions, data models, or API contracts before planning.

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 9 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

4 rules. 0 are common, 1 is distinctive, and 3 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.

  • 3

    Very specific

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

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

    If you are running this skill in Codex, read ../references/codex-compatibility.md before following host-specific tool instructions.

    line 10
  2. Very specific:

    Write a spec to docs/drafts/YYYY-MM-DD-<feature>-spec.md.

    line 26
  3. Distinctive:

    Start with YAML frontmatter:

    line 27
  4. Very specific:

    If docs/architecture/COMPONENTS.md exists, read it before creating or specifying UI components — reuse or extend an existing component on …

    line 59

“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

Host Compatibility

If you are running this skill in Codex, read ../references/codex-compatibility.md before following host-specific tool instructions. Claude Code should continue to use the Claude-specific tools and command wrappers described here.

Soloship Spec

Your job is to create a formal specification for a feature that needs more rigor than a brainstorm doc but less overhead than a full planning process.

When to Use This

  • The feature has multiple stakeholders with different expectations
  • Success/failure criteria must be explicit and agreed upon
  • Data models or API contracts need to be defined before building
  • The feature will be tested against specific acceptance criteria

What to Produce

Write a spec to docs/drafts/YYYY-MM-DD-<feature>-spec.md. Start with YAML frontmatter:

---
date: YYYY-MM-DD
producer: soloship-spec
version: 1
status: Draft
ttl_days: 14
---

Include these sections:

1. Problem Statement

One paragraph: what problem does this solve, for whom, and why now?

2. Success Criteria

Numbered list of specific, testable conditions. Each criterion should be verifiable — "user can X" not "the system is good."

3. Data Model (if applicable)

TypeScript interfaces, database schemas, or data structures. Show the shape of the data, not the implementation.

4. API Contract (if applicable)

Endpoints, request/response shapes, error codes. Focus on the interface, not the implementation.

5. User Flow

Step-by-step: what does the user do, what do they see at each step?

<!-- concern:component-reuse -->

If docs/architecture/COMPONENTS.md exists, read it before creating or specifying UI components — reuse or extend an existing component on purpose match, cite what you found, and apply the rule of three (see references/component-inventory.md). Specs that name UI surfaces should name the existing components they reuse, not invent new ones the inventory covers. Include error states and edge cases.

6. Out of Scope

Explicitly list what this feature does NOT include. Prevents scope creep.

7. Open Questions

Anything unresolved that needs a decision before building.

Common misreads

  • "We can figure out edge cases during implementation" → edge cases discovered during implementation become scope creep, rework, or bugs shipped to production. Specs exist to find them early.
  • "The API contract is obvious from the feature description" → "obvious" contracts have implicit assumptions about error codes, pagination, auth, and rate limits that only become explicit when you write them down.
  • "Data model will emerge naturally from the code" → emergent data models produce inconsistent naming, missing relationships, and migration nightmares. Decide the shape before you build.
  • "Out of Scope section is unnecessary — we know what we're building" → without explicit boundaries, every conversation adds "one more thing." Out of Scope is scope defense.
  • "Open Questions can wait" → unresolved questions become blocked PRs, mid-sprint pivots, and "I thought you meant..." conversations. Surface them now.

After the Spec

Suggest:

"Spec complete. Run /plan to create an implementation plan from this spec."

Verification

The spec is not complete until ALL of these are true:

  • Spec file exists at docs/drafts/YYYY-MM-DD-<feature>-spec.md
  • Problem Statement is one paragraph (not a feature list)
  • Success Criteria are numbered and each is independently testable
  • Data Model section present (or explicitly marked N/A with reason)
  • API Contract section present (or explicitly marked N/A with reason)
  • User Flow includes at least one error state
  • Out of Scope lists at least one thing
  • Open Questions section present (empty is fine if genuinely resolved)

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.