Agent skill

mcaf-nfr

Capture or refine non-functional requirements such as accessibility, reliability, scalability, maintainability, performance, and compliance. Use when a feature or architecture change needs explicit quality attributes and trade-offs.

Stars 47
Forks 6

Install this agent skill to your Project

npx add-skill https://github.com/managedcode/MCAF/tree/main/skills/mcaf-nfr

SKILL.md

MCAF: Non-Functional Requirements

Trigger On

  • a feature or architecture change needs explicit quality attributes
  • a team is using vague words like "fast", "reliable", or "secure" without measurable meaning
  • docs, ADRs, and tests are out of sync on quality expectations

Value

  • produce a concrete project delta: code, docs, config, tests, CI, or review artifact
  • reduce ambiguity through explicit planning, verification, and final validation skills
  • leave reusable project context so future tasks are faster and safer

Do Not Use For

  • generic architecture or feature writing with no quality-attribute decision
  • loading all NFR references at once

Inputs

  • the changed feature, boundary, or rollout path
  • the quality attributes that materially affect it
  • current docs, ADRs, tests, and ops expectations

Quick Start

  1. Read the nearest AGENTS.md and confirm scope and constraints.
  2. Run this skill's Workflow through the Ralph Loop until outcomes are acceptable.
  3. Return the Required Result Format with concrete artifacts and verification evidence.

Workflow

  1. Decide which quality attributes materially affect the change.
  2. Turn vague goals into explicit requirements, constraints, or testable expectations.
  3. Link NFRs to feature docs, ADRs, and verification when they affect design or rollout.
  4. Use only the specific reference files that match the active quality attribute.

Deliver

  • explicit NFRs for the changed area
  • docs or ADRs that describe measurable quality attributes
  • better alignment between architecture, testing, and operations

Validate

  • each chosen NFR is measurable or at least falsifiable
  • the selected attributes are the ones that actually drive design trade-offs
  • verification and operational expectations are linked where needed

Ralph Loop

Use the Ralph Loop for every task, including docs, architecture, testing, and tooling work.

  1. Brainstorm first (mandatory):
    • analyze current state
    • define the problem, target outcome, constraints, and risks
    • generate options and think through trade-offs before committing
    • capture the recommended direction and open questions
  2. Plan second (mandatory):
    • write a detailed execution plan from the chosen direction
    • list final validation skills to run at the end, with order and reason
  3. Execute one planned step and produce a concrete delta.
  4. Review the result and capture findings with actionable next fixes.
  5. Apply fixes in small batches and rerun the relevant checks or review steps.
  6. Update the plan after each iteration.
  7. Repeat until outcomes are acceptable or only explicit exceptions remain.
  8. If a dependency is missing, bootstrap it or return status: not_applicable with explicit reason and fallback path.

Required Result Format

  • status: complete | clean | improved | configured | not_applicable | blocked
  • plan: concise plan and current iteration step
  • actions_taken: concrete changes made
  • validation_skills: final skills run, or skipped with reasons
  • verification: commands, checks, or review evidence summary
  • remaining: top unresolved items or none

For setup-only requests with no execution, return status: configured and exact next commands.

Load References

  • pick only the exact file for the active NFR: accessibility, reliability, performance, scalability, compliance, maintainability, and so on

Example Requests

  • "Make the non-functional requirements explicit for this feature."
  • "Turn vague reliability goals into real constraints."
  • "Document performance and compliance expectations for this service."

Expand your agent's capabilities with these related and highly-rated skills.

managedcode/MCAF

mcaf-architecture-overview

Create or update `docs/Architecture.md` as the global architecture map for a solution. Use when bootstrapping a repo, onboarding, or changing modules, boundaries, or contracts. Keep it navigational and use `references/overview-template.md` for scaffolding.

47 6
Explore
managedcode/MCAF

mcaf-human-review-planning

Plan a human review for a large AI-generated code drop by reading the target area, tracing the natural user and system flows, identifying the riskiest boundaries, and prioritizing the files a human should inspect first. Use when the codebase is too large to review line-by-line and you need a practical review sequence plus a prioritized file list.

47 6
Explore
managedcode/MCAF

mcaf-documentation

Create or refine durable engineering documentation: docs structure, navigation, source-of-truth placement, and writing quality. Use when a repo’s docs are missing, stale, duplicated, or hard to navigate, or when adding new durable engineering guidance.

47 6
Explore
managedcode/MCAF

mcaf-observability

Design or improve observability for application and delivery flows: logs, metrics, traces, correlation, alerts, and operational diagnostics. Use when a change affects runtime visibility, failure diagnosis, SLOs, or alerting.

47 6
Explore
managedcode/MCAF

mcaf-agile-delivery

Shape delivery workflow around backlog quality, roles, ceremonies, and engineering feedback. Use when defining how the team plans, tracks work, and turns feedback into durable improvements.

47 6
Explore
managedcode/MCAF

mcaf-solid-maintainability

Apply SOLID, SRP, cohesion, composition-over-inheritance, and small-file discipline to code changes. Use when refactoring large files or classes, setting maintainability limits in `AGENTS.md`, documenting justified exceptions, or reviewing design quality.

47 6
Explore

Didn't find tool you were looking for?

Be as detailed as possible for better results