agentleFS
gofixpointgofixpoint/amika/.agents/skills/new-spec/SKILL.md

new-spec

Skill301 starsChanged 11 days agoApache-2.0View on GitHub

Create a new specification document in the specs/ directory. Use when the user asks to create a spec, write a specification, draft a spec, add a new spec, or generate a specification document.

12 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use release.

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.
  • MicrosoftSkill

    release

    Use ONLY when the user explicitly asks to cut/publish a Huabu desktop release or tag a version. Performs an outward action — bumps the version in apps/desktop/package.json, commits + annotated-tags vX.Y.Z, and pushes the branch + tag. That tag push auto-builds the macOS/Windows installers and publishes a GitHub Release. Provides `status`, `bump`, `tag-push`, and a one-command `run` (bump → tag-push).

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

10 rules. 0 are common, 4 are distinctive, and 6 are very specific to this project.

  • 0

    Common

    Most of the 11 edited versions we read keep these.

  • 4

    Distinctive

    This author's own choices. Worth a look.

  • 6

    Very specific

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

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

    Create the file: Use the name specs/<NNN>-<name>.md.

    line 14
  2. Very specific:

    Do not create a .d directory when you create the spec.

    line 42
  3. Very specific:

    Put supporting documents for specs/NNN-name.md in specs/NNN-name.d/.

    line 65
  4. Distinctive:

    Create the directory when you add the first document.

    line 66
  5. Very specific:

    Do not rename or renumber the .d directory alone.

    line 67
  6. Very specific:

    Keep all design decisions in the .md spec, not in .d/.

    line 71
  7. Very specific:

    When a .d directory has more than two or three files, add a README.md to it.

    line 73
  8. Distinctive:

    Do not commit raw output, such as large logs or benchmark dumps.

    line 77
  9. Distinctive:

    Use specs to record product, design, and technical decisions.

    line 82
  10. Distinctive:

    Write for human reviewers.

    line 86

“Common” is measured: kept by at least 6 in 10 of the 11 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

Create a New Specification

Procedure

  1. Find the next number. List the files in specs/. Find the highest number prefix. Add 1 to it. Use three digits with leading zeros. For example, if 002-foo.md is the highest, the next number is 003.
  2. Create the file. Use the name specs/<NNN>-<name>.md. Get <name> from $ARGUMENTS. If $ARGUMENTS is empty, ask the user for a name.
  3. Use this template:
# <Title>

## Overview

<Brief summary of what this spec covers>

## <Main Sections>

<Detailed content organized into logical sections>

## Dependencies

<External requirements, if any>

## Future Considerations

<Known limitations and potential future work>
  1. Write the content. Work with the user to fill in the spec from their requirements.

Do not create a .d directory when you create the spec. Create it only when the spec has supporting documents.

Supporting Documents: the .d Directory

A spec can have a sibling directory. The directory has the same name as the spec, but .d replaces .md:

specs/019-sandbox-ssh-stream-relay.md     <- the spec
specs/019-sandbox-ssh-stream-relay.d/     <- its supporting documents

The .md file is the specification. It tells what the team will build and why. It must be complete and easy to review alone.

The .d directory holds working documents that support the spec. These documents would make the spec too long. Examples are implementation plans, test plans, critiques, run evidence, prompts, follow-up lists, and design notes.

Obey these rules:

  • Put supporting documents for specs/NNN-name.md in specs/NNN-name.d/. Create the directory when you add the first document.
  • Do not rename or renumber the .d directory alone. If you rename the spec, rename its .d directory too.
  • The .md spec is the authority. If a .d/ document does not agree with the spec, the spec is correct. Update the spec or correct the document.
  • Keep all design decisions in the .md spec, not in .d/. The spec can link to .d/ for more detail. A reader must understand the spec without .d/.
  • When a .d directory has more than two or three files, add a README.md to it. The README.md links back to the spec. It lists each document and gives its purpose in one line.
  • A document in .d/ can have its own .d directory. The same rules apply.
  • Do not commit raw output, such as large logs or benchmark dumps. Commit only evidence that you examined and cleaned.

Guidelines

  • Use specs to record product, design, and technical decisions.
  • Give sufficient detail to implement the spec. Do not paste large blocks of code.
  • Tell why you made a decision, not only what the decision is.
  • Write for human reviewers.

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.