agentleFS
converge-ai-labsconverge-ai-labs/agent-foundation/.agents/skills/spec-writing/SKILL.md

spec-writing

Skill1.3k starsChanged 3 days agoApache-2.0View on GitHub

Author, review, or reorganize accepted technical contracts under spec/, including domain models, lifecycles, APIs, protocols, ownership, security, and compatibility. Use when a task changes or evaluates those contracts; ordinary implementation details do not require a spec rewrite.

17 other projects use a version of this.

Trending

More talk lately.about the whole repository

Dec 2025: 0 mentionsJan 2026: 0 mentionsFeb 2026: 0 mentionsMar 2026: 0 mentionsApr 2026: 0 mentionsMay 2026: 0 mentionsJun 2026: 0 mentionsJul 2026: 0 mentionsAug 2026: 0 mentionsSep 2026: 22 mentionsOct 2026: 24 mentionsNov 2026: 4 mentions
Dec 2025Jun 2026Nov 2026
Mentions a month of the converge-ai-labs/agent-foundation repository that our weekly crawl found. There is no adoption data for this file yet.

Most recently taken up by

Who's talking about converge-ai-labs/agent-foundation

The biggest 5 of 50 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 50

Talked about on GitHub (50 times).

On GitHub · 50

45 more on GitHub

The file

We split this skill into the rules it gives an agent

8 rules. 0 are common, 6 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 15 edited versions we read keep these.

  • 6

    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:

    Read spec/README.md, the relevant subsystem index/reading path, and the documents that own changed concepts.

    line 12
  2. Distinctive:

    Read structure-and-template.md when adding or splitting documents, changing ownership/navigation, or choosing a contract's structure.

    line 20
  3. Distinctive:

    Write the resulting design in present tense with testable statements.

    line 26
  4. Distinctive:

    Read domain-modeling-and-naming.md when adding or reshaping concepts, schemas, identities, lifecycles, or shared terms.

    line 28
  5. Distinctive:

    Use upstream public primitives when they already own the semantics.

    line 30
  6. Distinctive:

    Use a diagram or table when it clarifies the contract.

    line 34
  7. Distinctive:

    Search changed terminology and update stale summaries, incoming links, and dependent contracts.

    line 38
  8. Very specific:

    Verify one owner for each fact, consistent identity/version/state terms, and explicit independent completion boundaries.

    line 39

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

Specification Authoring

Maintain spec/ as the current, internally consistent accepted design. Follow AGENTS.md and CONTRIBUTING.md; Repository Model defines what belongs in specifications.

Establish Authority

Read spec/README.md, the relevant subsystem index/reading path, and the documents that own changed concepts. Search affected terms, states, schemas, and claims across spec/. Reuse context already read.

Use the accepted outcome supplied by the user or concluded discussion. Do not infer a new product or architecture decision from implementation behavior alone. If material alternatives remain unresolved, identify the decision and continue independent authorized work; keep the unsettled design out of spec/. The Issue-to-PR workflow does not itself authorize posting to GitHub.

Choose the Owner

Each durable fact has one owning contract. Update that owner first, then affected summaries, catalogs, reading paths, and incoming links. Preserve established terms and ownership unless the accepted change replaces them.

Read structure-and-template.md when adding or splitting documents, changing ownership/navigation, or choosing a contract's structure. Ordinary edits can retain the existing structure.

Keep platform definition in spec/README.md, subsystem navigation in its README.md, architecture in 00-overview.md, and detailed contracts in cohesive numbered documents. Overviews link to detailed schemas and state machines rather than becoming competing owners. Do not renumber stable files casually or create empty templates/placeholders in spec/.

Write the Contract

Write the resulting design in present tense with testable statements. Explain purpose, ownership, authority, and observable behavior. Include applicable data types, lifecycle/completion boundaries, failure/cancellation/retry/unknown-outcome semantics, security, compatibility, and verifiable invariants.

Read domain-modeling-and-naming.md when adding or reshaping concepts, schemas, identities, lifecycles, or shared terms. Derive models from representative flows before drafting fields or APIs.

Use upstream public primitives when they already own the semantics. Introduce project abstractions only for a stable cross-host or cross-provider contract. Label conceptual Python-like schemas explicitly; distinguish them from serialized wire formats.

Omit private classes, layouts, hooks, and algorithms that can change without affecting observable behavior, authority, security, or compatibility. Keep accepted trade-offs when they explain the cost of the selected design. Proposals, rejected alternatives, discussion history, progress, tutorials, runbooks, and contributor procedures belong in the surfaces assigned by Repository Model.

Use a diagram or table when it clarifies the contract. Prefer Mermaid for architecture, state, or interaction diagrams, and keep diagrams, schemas, tables, and prose semantically aligned.

Check Consistency and Validate

  • Search changed terminology and update stale summaries, incoming links, and dependent contracts.
  • Verify one owner for each fact, consistent identity/version/state terms, and explicit independent completion boundaries.
  • Distinguish process-local observations from durable facts and transport delivery from execution authority.
  • Make security and compatibility failures explicit. Remove stale text, orphan sections, duplication, and editing residue so the result stands alone without issue history.

For spec-only changes, format the affected files and run:

uv run --locked mdformat --number <changed-spec-files>
make verify
git diff --check -- spec

For accompanying implementation or shared tooling, complete the applicable repository/component gates. Reuse valid results and rerun checks when their inputs change. Report validation and unresolved decisions without claiming that formatting proves semantic correctness.

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.