agentleFS
agent-ixagent-ix/spec-skills/spec-write-nfr/SKILL.md

spec-write-nfr

Skill1 starsChanged 6 months agoMITView on GitHub

Define a normative Non-Functional Requirement (NFR) or quality constraint.

The file

We split this skill into the rules it gives an agent

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

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use this skill to define constraints on *how well* the system performs (quality attributes).

    line 8
  2. Distinctive:

    No Behavior: Do not define *what* the system does, but *how* it does it.

    line 14
  3. Distinctive:

    Every NFR file MUST contain the following YAML frontmatter:

    line 45

≈ “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

Write Non-Functional Requirement

Use this skill to define constraints on how well the system performs (quality attributes).

Rules

  • One Attribute: One quality per NFR (e.g., Security, Performance).
  • Measurable: Must be objectively assessable.
  • No Behavior: Do not define what the system does, but how it does it.
  • Normative: Use SHALL.
  • Traceable: Impacted FRs must be defined in the YAML frontmatter relationships: array.

Attributes (ISO 25010)

  • Performance Efficiency
  • Reliability / Availability
  • Security
  • Usability
  • Maintainability
  • Portability
  • Scalability
  • Compliance

Process

  1. Select Attribute: Choose primary quality attribute.
  2. Use Template:
    • Source: assets/nonfunctional-requirement-template.md
  3. Define:
    • Statement: Atomic normative constraint.
    • Measurement: Metric, Target, Threshold, Method (required table).
    • Verification: objective, repeatable check of the table.
    • Impact: List affected FRs (FR-XXX).
  4. Output: Save to correct location.
    • Single Repo: spec/non-functional/NFR-XXX-description.md
    • Multi-Repo: specs/<category>/<component>/spec/non-functional/NFR-XXX-description.md

Frontmatter (Required)

Every NFR file MUST contain the following YAML frontmatter:

---
id: NFR-XXX
title: "<Title>"
artifact_type: NFR
quality_attribute: performance_efficiency   # ISO 25010 enum (snake_case) — replaces the retired "## Quality Attribute" section
relationships:          # Required: Structured array of affected FRs
  - target: "ix://org/repo/FR-XXX"
    type: "constrains"
    cardinality: "1:N"
---

Body Shape (spec-artifacts-iso v0.2.0)

  • REQUIRED (level 2): ## Statement, ## Measurement and Evaluation (table headers exactly Metric | Target | Threshold | Method, ≥1 row), ## Verification.
  • OPTIONAL: ## Scope, ## Rationale, ## Acceptance Criteria, ## Dependencies. The Measurement table IS the acceptance-criteria equivalent for measurable NFRs; use the optional AC section only for policy NFRs whose compliance checks don't reduce to metrics.
  • quality_attribute lives in FRONTMATTER (enum), not as a body section.

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.