agentleFS
Luis85Luis85/agentic-workflow/.claude/skills/new-glossary-entry/SKILL.md

new-glossary-entry

Skill0 starsChanged 6 months agoMITView on GitHub

Scaffold a glossary entry at docs/glossary/<slug>.md from template. Triggers /glossary:new, "glossary", "define this term", "add glossary entry", or terminology ambiguity. Replaces ubiquitous-language (ADR-0010).

The file

We split this skill into the rules it gives an agent

11 rules. About 0 are common, 3 are distinctive, and 8 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 8

    Very specific

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

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

    Create a new per-term file under docs/glossary/ from templates/glossary-entry-template.md, with the slug, term, and last-updated pre-filled.

    line 12
  2. Very specific:

    Use this skill when invoked via /glossary:new "<term>" or whenever a new term needs an entry.

    line 14
  3. Very specific:

    Check for an existing entry: If docs/glossary/<slug>.md already exists, do not overwrite.

    line 25
  4. Very specific:

    Draft body sections from conversation context: If the user supplied a definition, fill ## Definition with one sentence.

    line 38
  5. Very specific:

    Cross-link from related entries: if any exist under docs/glossary/.

    line 40
  6. Distinctive:

    If the entry already existed, report:

    line 55
  7. Distinctive:

    Do not overwrite an existing entry.

    line 66
  8. Very specific:

    Do not delete a deprecated entry.

    line 67
  9. Very specific:

    Do not mark a new entry accepted without explicit human approval.

    line 68
  10. Distinctive:

    Do not add an entry for an implementation detail or ephemeral identifier (e.g.

    line 69
  11. Very specific:

    Do not edit docs/UBIQUITOUS_LANGUAGE.md — that file is deprecated by ADR-0010.

    line 70

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “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

new-glossary-entry — scaffold a new glossary entry

Purpose

Create a new per-term file under docs/glossary/ from templates/glossary-entry-template.md, with the slug, term, and last-updated pre-filled. The new file is the canonical home for one term — its definition, why it matters, examples, what to avoid, and links to related terms.

Use this skill when invoked via /glossary:new "<term>" or whenever a new term needs an entry.

For background on what counts as a glossary-worthy term and how the glossary is governed, see ADR-0010, templates/glossary-entry-template.md, and Article VIII — Plain Language of the constitution.

How to use

  1. Slugify the term. Lowercase, alphanumerics and hyphens only; collapse runs of non-alphanumerics to a single hyphen; trim leading/trailing hyphens. Examples:
    • Quality gate → quality-gate
    • EARS notation → ears-notation
    • Retrospective → retrospective
  2. Check for an existing entry. If docs/glossary/<slug>.md already exists, do not overwrite. Stop and report the existing path; offer to refine it in place instead (update the body, bump last-updated, add a Refined <YYYY-MM-DD> in workflow <slug> note in the Definition section).
  3. Compose the path: docs/glossary/<slug>.md.
  4. Copy templates/glossary-entry-template.md to that path and fill the frontmatter:
    • term: "<canonical term in display case>"
    • slug: <slug>
    • aliases: [] (add known synonyms only if the user has explicitly named them as "avoid this synonym")
    • status: draft (a human flips to accepted after review)
    • last-updated: <today's UTC date, YYYY-MM-DD>
    • related: [] (add slugs of obviously-related terms; leave empty if unsure)
    • tags: [] (assign at most 2 — common tags: workflow, role, artifact, governance, quality, process)
  5. Draft body sections from conversation context. If the user supplied a definition, fill ## Definition with one sentence. Leave ## Examples, ## Avoid, and ## See also empty for the user to complete unless they have already given that content.
  6. Cross-link from related entries if any exist under docs/glossary/. Add the new slug to their related: frontmatter and to their ## See also section. Keep links bidirectional.
  7. If invoked from inside a feature workflow, append a dated one-line entry to that feature's specs/<slug>/workflow-state.md ## Hand-off notes free-form section so the workflow has a paper trail. Per docs/sink.md §"Cross-cutting writes from skills". The frontmatter schema is fixed — do not add new keys.

Reporting

On success, report:

Created glossary entry: <Term>
  path: docs/glossary/<slug>.md
  status: draft
  related: <list or none>

If the entry already existed, report:

Glossary entry already exists: <Term>
  path: docs/glossary/<slug>.md
  status: <existing status>
Refine in place? (skill will not overwrite)

Do not

  • Do not overwrite an existing entry. Refine in place instead, with a dated note.
  • Do not delete a deprecated entry. It remains as historical record with status: deprecated. Renames create a new entry and link via aliases: from the new file.
  • Do not mark a new entry accepted without explicit human approval. New entries start draft.
  • Do not add an entry for an implementation detail or ephemeral identifier (e.g. specific class names, request IDs, transient feature flags). Glossary entries are domain language, not implementation language.
  • Do not edit docs/UBIQUITOUS_LANGUAGE.md — that file is deprecated by ADR-0010. New terms go here.

Relationship to other artifacts

  • docs/CONTEXT.md (and docs/contexts/<name>.md) — uses these terms exactly; defers to docs/glossary/<slug>.md for definitions.
  • docs/steering/product.md — uses these terms exactly; refining a term may require a steering update.
  • specs/<slug>/requirements.md — every EARS clause uses these terms exactly (per docs/ears-notation.md discipline). The reviewer agent checks this at /spec:review time.
  • Code identifiers — class, function, and variable names should mirror these terms within language conventions. The reviewer agent enforces this.

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.