mcpField
T
to-spec

to-spec

github.com/yahyabedirhanDevelopment269 installsUpdated 1d ago
Repository

About to-spec

A skill that turns the current conversation and codebase understanding into a project specification. It explores the repository, proposes test seams, then writes and publishes the spec to the project tracker.

Key features

  1. 01Inspect repository state and glossary
  2. 02Identify feature testing seams
  3. 03Draft a structured specification
  4. 04Publish spec with triage label

Use cases

  1. 01Turn a feature discussion into a spec
  2. 02Document implementation and testing decisions
  3. 03Prepare work for agent-ready project tracking

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/yahyabedirhan/skills --skill to-spec

After installing, type/to-specin Claude Code to confirm it loaded.

Bundled filesagents/openai.yamlLICENSE.mattpocock

Details

From the project README

This skill takes the current conversation context and codebase understanding and produces a spec. Do NOT interview the user; just synthesize what you already know.

The issue tracker and triage label vocabulary should have been provided to you. If not, run the set-up-project skill first.

Process

  1. Explore the repo to understand the current state of the codebase, if you haven't already. Use the project's domain glossary vocabulary throughout the spec, and respect any ADRs in the area you're touching.

  2. Sketch out the seams at which you're going to test the feature. Existing seams should be preferred to new ones. Use the highest seam possible. If new seams are needed, propose them at the highest point you can. The fewer seams across the codebase, the better - the ideal number is one.

Check with the user that these seams match their expectations.

  1. Write the spec using the template below, then publish it to the project issue tracker. Apply the ready-for-agent triage label - no need for additional triage. Title it as docs/agents/issue-tracker.md > 'Title prefixes' says.

On a local-files tracker, write the spec to .efforts/<effort>/spec.md, where <effort> is the effort's name (or a short slug for the feature when there is no effort). Its tickets go beside it, in .efforts/<effort>/issues/.

Problem Statement

The problem that the user is facing, from the user's perspective.

Solution

The solution to the problem, from the user's perspective.

User Stories

A LONG, numbered list of user stories. Each user story should be in the format of:

  1. As an , I want a , so that
1. As a mobile bank customer, I want to see balance on my accounts, so that I can make better informed decisions about my spending

This list of user stories should be extremely extensive and cover all aspects of the feature.

Implementation Decisions

A list of implementation decisions that were made. This can include:

  • The modules that will be built/modified
  • The interfaces of those modules that will be modified
  • Technical clarifications from the developer
  • Architectural decisions
  • Schema changes
  • API contracts
  • Specific interactions

Do NOT include specific file paths or code snippets. They may end up being outdated very quickly.

Exception: if a prototype produced a snippet that encodes a decision more precisely than prose can (state machine, reducer, schema, type shape), inline it within the relevant decision and note briefly that it came from a prototype. Trim to the decision-rich parts, not a working demo, just the important bits.

Testing Decisions

A list of testing decisions that were made. Include:

  • A description of what makes a good test (only test external behavior, not implementation details)
  • Which modules will be tested
  • Prior art for the tests (i.e. similar types of tests in the codebase)

Out of Scope

A description of the things that are out of scope for this spec.

Further Notes

Any further notes about the feature.

Comments

Markdown supported