> ## Documentation Index
> Fetch the complete documentation index at: https://getquality.md/llms.txt
> Use this file to discover all available pages before exploring further.

# Welcome

> Model your project's quality so teams and agents can evaluate it, stay aligned on what good means, and improve it over time.

<div className="relative px-6 pt-1 pb-12 lg:pt-28 max-w-8xl mx-auto text-center">
  <div className="mb-6 flex justify-center" aria-hidden="true">
    <img src="https://mintcdn.com/qualitymd/bSsVVsI2x8rBpI9m/images/favicon-light.svg?fit=max&auto=format&n=bSsVVsI2x8rBpI9m&q=85&s=e4e529763b015ea1142897d25d711796" alt="" className="block dark:hidden h-24 w-24 " width="683" height="683" data-path="images/favicon-light.svg" />

    <img src="https://mintcdn.com/qualitymd/bSsVVsI2x8rBpI9m/images/favicon-dark.svg?fit=max&auto=format&n=bSsVVsI2x8rBpI9m&q=85&s=308882154a517fc4d238824ee9043696" alt="" className="hidden dark:block h-24 w-24 " width="683" height="683" data-path="images/favicon-dark.svg" />
  </div>

  <h1 className="text-4xl sm:text-5xl lg:text-6xl font-bold tracking-tight text-gray-900 dark:text-zinc-50">
    QUALITY.md
  </h1>

  <p className="mt-3 text-sm font-semibold uppercase tracking-widest text-[#5B68EE] dark:text-[#A4ACF2]">
    <a href="/specification" className="font-mono text-inherit no-underline border-b border-transparent hover:border-current">
      Open format
    </a>

    {" · "}

    <a href="/skill" className="font-mono text-inherit no-underline border-b border-transparent hover:border-current">
      Agent skill
    </a>

    {" · "}

    <a href="/cli" className="font-mono text-inherit no-underline border-b border-transparent hover:border-current">
      CLI
    </a>
  </p>

  <p className="mt-10 text-lg lg:text-xl leading-relaxed text-gray-600 dark:text-zinc-400 max-w-2xl mx-auto">
    Engineer loops to improve project quality, aligning your team and agents on
    what quality means for what matters most.
  </p>

  <div className="mt-10 flex flex-wrap items-center justify-center gap-3">
    <a href="/quickstart" className="inline-flex items-center justify-center rounded-lg bg-[#5B68EE] px-5 py-2.5 text-sm font-semibold text-white no-underline shadow-sm hover:bg-[#4853D6] transition-colors">
      <Icon icon="rocket" color="#FFFFFF" size={16} className="mr-2" />

      Getting started
    </a>

    <a href="/loops" className="inline-flex items-center justify-center rounded-lg border border-gray-200 dark:border-zinc-700 px-5 py-2.5 text-sm font-semibold text-gray-900 dark:text-zinc-100 no-underline hover:bg-gray-50 dark:hover:bg-zinc-800 transition-colors">
      <Icon icon="repeat" size={16} className="mr-2" />

      Engineer quality loops
    </a>

    <a href="/specification" className="inline-flex items-center justify-center rounded-lg border border-gray-200 dark:border-zinc-700 px-5 py-2.5 text-sm font-semibold text-gray-900 dark:text-zinc-100 no-underline hover:bg-gray-50 dark:hover:bg-zinc-800 transition-colors">
      <Icon icon="book-open" size={16} className="mr-2" />

      Read the spec
    </a>
  </div>
</div>

<div className="px-6 sm:px-8 lg:px-6 max-w-5xl mx-auto">
  <h3 className="text-xl sm:text-md lg:text-lg font-bold tracking-tight text-gray-900 dark:text-zinc-50 text-center">
    What is QUALITY.md?
  </h3>

  <p className="mt-2 text-md lg:text-md leading-relaxed text-gray-600 dark:text-zinc-400 max-w-2xl mx-auto">
    QUALITY.md is an{" "}

    <a href="/specification" className="font-medium text-[#5B68EE] underline decoration-[#5B68EE]/30 underline-offset-4 hover:decoration-current dark:text-[#A4ACF2] dark:decoration-[#A4ACF2]/40">
      open file format
    </a>

    {" "}

    for declaring a project quality model: a holistic rubric of the desired
    quality characteristics (security, maintainability, code quality, test/spec
    quality, etc.), their quality requirements (guides, sensors, principles,
    standards, rules, specs), and the context (mission/purpose, user/stakeholder
    needs, risks, etc.) for why they matter.{" "}
  </p>

  <p className="mt-2 text-md lg:text-md leading-relaxed text-gray-600 dark:text-zinc-400 max-w-2xl mx-auto">
    The QUALITY.md format{" "}

    <a href="/specification" className="font-medium text-[#5B68EE] underline decoration-[#5B68EE]/30 underline-offset-4 hover:decoration-current dark:text-[#A4ACF2] dark:decoration-[#A4ACF2]/40">
      specification
    </a>

    {" "}

    is designed to be agent, tool, and vendor agnostic. The companion `/quality`{" "}

    <a href="/skill" className="font-medium text-[#5B68EE] underline decoration-[#5B68EE]/30 underline-offset-4 hover:decoration-current dark:text-[#A4ACF2] dark:decoration-[#A4ACF2]/40">
      agent skill
    </a>

    {" "}

    and `qualitymd`{" "}

    <a href="/cli" className="font-medium text-[#5B68EE] underline decoration-[#5B68EE]/30 underline-offset-4 hover:decoration-current dark:text-[#A4ACF2] dark:decoration-[#A4ACF2]/40">
      CLI
    </a>

    {" "}

    serve as both a reference implementation and starter kit for working with
    `QUALITY.md` files, including the ability to create a comprehensive{" "}

    <a href="https://github.com/qualitymd/quality.md/blob/main/examples/report-gallery/software-service/.quality/evaluations/0001-full-eval/report.md" className="font-medium text-[#5B68EE] underline decoration-[#5B68EE]/30 underline-offset-4 hover:decoration-current dark:text-[#A4ACF2] dark:decoration-[#A4ACF2]/40">
      quality evaluation report
    </a>

    {" "}

    with prioritized{" "}

    <a href="https://github.com/qualitymd/quality.md/blob/main/examples/report-gallery/software-service/.quality/evaluations/0001-full-eval/recommendations.md" className="font-medium text-[#5B68EE] underline decoration-[#5B68EE]/30 underline-offset-4 hover:decoration-current dark:text-[#A4ACF2] dark:decoration-[#A4ACF2]/40">
      improvement recommendations
    </a>

    {" "}

    ready for handoff or further review, useful for engineering quality loops or
    augmenting your existing workflow.
  </p>

  <h3 className="mt-12 text-xl sm:text-md lg:text-lg font-bold tracking-tight text-gray-900 dark:text-zinc-50 text-center">
    Why QUALITY.md?
  </h3>

  <ul className="mt-2 text-md lg:text-md leading-relaxed text-gray-600 dark:text-zinc-400 max-w-xl mx-auto list-disc pl-6">
    <li>Ensure stakeholders are aligned on what matters most and why</li>
    <li>Identify the most impactful and low risk quality improvements</li>

    <li>
      Build agentic control loops to continuously maintain and improve quality
    </li>

    <li>Manage quality proactively instead of reactively</li>
    <li>Tackle intent, comprehension, and technical debt</li>
    <li>Move judgement and taste up the loop stack</li>
    <li>Compound learning at the highest leverage point</li>
  </ul>

  <h3 className="mt-12 text-xl sm:text-md lg:text-lg font-bold tracking-tight text-gray-900 dark:text-zinc-50 text-center">
    Philosophy
  </h3>

  <p className="mt-2 text-md lg:text-md leading-relaxed text-gray-600 dark:text-zinc-400 max-w-2xl mx-auto">
    Maintaining the quality of a thing is caring for it. When a thing exists for the benefit of another, caring for it well is caring for the other well.
  </p>

  <p className="mt-2 text-md lg:text-md leading-relaxed text-gray-600 dark:text-zinc-400 max-w-2xl mx-auto">
    The aim of QUALITY.md is to help others care well by making the practice of maintenance accessible to humans and agents.
  </p>

  <h3 className="mt-12 text-xl sm:text-md lg:text-lg font-bold tracking-tight text-gray-900 dark:text-zinc-50 text-center">
    How to use QUALITY.md?
  </h3>

  <div className="mt-4 text-md lg:text-md leading-relaxed text-gray-600 dark:text-zinc-400 max-w-2xl mx-auto">
    <Steps>
      <Step title="Set up">
        <ol type="a">
          <li>
            <p>Install the `/quality` agent skill:</p>

            ```sh theme={null}
            npx skills add qualitymd/quality.md
            ```
          </li>

          <li>
            <p>Install the `qualitymd` CLI:</p>

            ```sh theme={null}
            npm install -g quality.md
            ```

            <p>
              See <a href="/quickstart">getting started</a> for other install
              methods.
            </p>
          </li>

          <li>
            <p>
              Invoke `/quality setup` to create a tailored `QUALITY.md` for
              evaluation and continued refinement.
            </p>
          </li>
        </ol>
      </Step>

      <Step title="Evaluate">
        Run `/quality evaluate` to generate a holistic quality report with
        findings and actionable recommendations. See the
        [example quality evaluation report](https://github.com/qualitymd/quality.md/blob/main/examples/report-gallery/software-service/.quality/evaluations/0001-full-eval/report.md).
      </Step>

      <Step title="Act">
        Hand off quality improvement recommendations to inner agent loops,
        teammates, or the workflow best suited to the change.
      </Step>

      <Step title="Improve">
        Run `/quality improve` to refine `QUALITY.md` from what the evaluation
        and improvement work revealed.
      </Step>

      <Step title="Loop">
        Return to Evaluate with a sharper model and continue compounding quality
        learning.
      </Step>
    </Steps>
  </div>
</div>

<div />

<div className="pt-10 px-6 pb-24 max-w-5xl mx-auto">
  <Columns cols={3}>
    <Card title="Quickstart" icon="rocket" href="/quickstart">
      Create your first QUALITY.md to establish a project quality model.
    </Card>

    <Card title="Engineer the Quality Loop" icon="repeat" href="/loops">
      Elevate quality evaluation and improvement up the loop stack.
    </Card>

    <Card title="Example quality evaluation" icon="file-check" href="https://github.com/qualitymd/quality.md/blob/main/examples/report-gallery/software-service/.quality/evaluations/0001-full-eval/report.md">
      See project quality ratings by project area and quality factor.
    </Card>

    <Card title="Specification" icon="book-open" href="/specification">
      The open, vendor-neutral, QUALITY.md standard.
    </Card>

    <Card title="/quality agent skill" icon="sparkles" href="/skill">
      Effortlessly set up, evaluate, and improve.
    </Card>

    <Card title="CLI reference" icon="terminal" href="/cli">
      QUALITY.md linting and management utilities.
    </Card>
  </Columns>
</div>

<div className="px-6 pb-16 max-w-3xl mx-auto">
  <h3 className="text-xl sm:text-md lg:text-lg font-bold tracking-tight text-gray-900 dark:text-zinc-50 text-center">
    FAQ
  </h3>

  <div className="mt-4">
    <AccordionGroup>
      <Accordion title="What is a quality model?">
        A quality model is an explicit, shared description of what "good" means
        for something you maintain. In QUALITY.md, that means the areas of a
        project, the quality factors that matter for each, and concrete
        requirements with checkable assessments — plus a rating scale for
        judging results and the context for why any of it matters. Instead of
        quality living in people's heads and scattered review comments, the
        model makes it visible enough for teams and agents to evaluate, align
        on, and improve.

        The idea has a long lineage. Manufacturing quality management
        (Shewhart's statistical quality control, Juran's "fitness for use")
        carried into software through McCall's and Boehm's models in the
        1970s, HP's FURPS, Dromey's model, and the ISO 9126 and ISO 25010
        standards. Across five decades the same pattern recurs: decompose
        quality into the characteristics that matter for a particular thing
        and its stakeholders, refine them into sub-characteristics, and tie
        those to assessable criteria.

        In practice, these models rarely spread beyond large organizations
        with formal quality programs: building and tailoring a detailed model
        was costly, and the metric-based rating methods meant to make quality
        measurable proved too reductive — or too complex — for everyday use.
        AI changes that. Agents make a tailored quality model cheap to
        establish and maintain, and inferential judging of quality
        requirements makes holistic evaluation accessible — good enough for
        many use cases where formal measurement never was.
      </Accordion>

      <Accordion title="What's covered by the formal QUALITY.md specification?">
        The [specification](/specification) defines the file format and its
        meaning: document structure (YAML frontmatter plus a Markdown body), the
        frontmatter schema for areas, factors, requirements, and the rating
        scale, naming and reference rules, and model semantics (how sources
        resolve, how requirements scope to their declaring area, how factors
        connect, and what the rating scale means). Conformance is a property of
        documents; the spec doesn't prescribe or certify any evaluation method.
        It's deliberately agent-, tool-, and vendor-agnostic. The
        [`/quality` skill](/skill) and [`qualitymd` CLI](/cli) are companions —
        a reference implementation and starter kit, not part of the format
        itself.
      </Accordion>

      <Accordion title="Is QUALITY.md only for modeling software quality?">
        No. The format is domain agnostic: it applies wherever you want to be
        deliberate about quality — documentation sets, data products, research
        reports, service operations, and more. There's no default factor
        checklist to import; each model earns its factors from the modeled
        thing's own needs and risks.
      </Accordion>

      <Accordion title="Is QUALITY.md open source? How is it licensed?">
        Yes. The specification, `/quality` agent skill, and `qualitymd` CLI are
        all developed in the open at
        [github.com/qualitymd/quality.md](https://github.com/qualitymd/quality.md)
        and released under the MIT license.
      </Accordion>

      <Accordion title="How does QUALITY.md relate to agent skills and rules (e.g. AGENTS.md/CLAUDE.md)?">
        They're complementary layers. Rules files like AGENTS.md or CLAUDE.md
        tell an agent *how* to work in your project, and skills give it
        procedures for specific tasks — both steer the inner coding loop, action
        by action. `QUALITY.md` declares *what quality means*: the shared bar
        the resulting work is judged against. The `/quality` skill connects the
        two — it reads your `QUALITY.md` to evaluate the project and produces
        recommendations you can hand off to any agent, teammate, or workflow. In
        loop terms, rules and skills guide the inner loop; QUALITY.md powers the
        evaluation and improvement loops above it.
      </Accordion>
    </AccordionGroup>
  </div>
</div>

<div role="contentinfo" className="px-6 pb-12 max-w-5xl mx-auto">
  <div className="border-t border-gray-100 dark:border-zinc-800 pt-8 flex items-center justify-center gap-4">
    <a href="https://github.com/qualitymd/quality.md" aria-label="GitHub" className="inline-flex h-10 w-10 items-center justify-center rounded-lg text-gray-700 no-underline transition-colors hover:bg-gray-50 dark:text-zinc-300 dark:hover:bg-zinc-800">
      <Icon icon="github" size={18} />
    </a>

    <a href="https://x.com/qualitydotmd" aria-label="X" className="inline-flex h-10 w-10 items-center justify-center rounded-lg text-gray-700 no-underline transition-colors hover:bg-gray-50 dark:text-zinc-300 dark:hover:bg-zinc-800">
      <Icon icon="x-twitter" size={18} />
    </a>
  </div>
</div>
