JSON Schema Preview

Appearance

Docs ​

Whether the project explains itself: the standard community files exist (README, CONTRIBUTING, code of conduct, security policy, license), a docs site is published, maturity is tracked over time, and — the depth signal — guide pages actually keep up with the feature specs.

4.3 / 58.63 of 10 weighted points earned — snapshot of 2026-09-02

readmeweight 1 ptearned 1 / 1​

Measures: README.md

Why this weight: The community-standard files are each binary and roughly equally important, so every presence check here carries the same single point.

contributingweight 1 ptearned 1 / 1​

Measures: CONTRIBUTING.md

Why this weight: Equal-weight presence check: how to contribute is one of the standard files a healthy repo simply has.

code-of-conductweight 1 ptearned 1 / 1​

Measures: CODE_OF_CONDUCT.md

Why this weight: Equal-weight presence check alongside the other community-standard files.

security-policyweight 1 ptearned 1 / 1​

Measures: SECURITY.md

Why this weight: Equal-weight presence check: a documented way to report vulnerabilities.

licenseweight 1 ptearned 1 / 1​

Measures: LICENSE.md

Why this weight: Equal-weight presence check: without a license the rest of the docs hardly matter.

docs-siteweight 1 ptearned 1 / 1​

Measures: a docs site (docs/) exists

Why this weight: Equal-weight presence check for a published site; its *depth* is scored separately by guide-coverage.

doc-coverageweight 3 ptsearned 1.63 / 3​

Measures: mean per-spec documentation depth: tagged doc words vs words expected from each spec’s evaluated complexity (S07-SR-10..12)

Why this weight: The only depth signal in the dimension: it measures how much of each spec is actually documented (words attributed via spec: tags, against a complexity-derived expectation), not whether files exist — replacing the old page-count ratio, which a stub page could satisfy. It moves with every requirement and every paragraph written, so it outweighs any single presence check.

maturity-trackedweight 1 ptearned 1 / 1​

Measures: MATURITY.md exists

Why this weight: Equal-weight presence check: maturity itself is tracked in a committed, dated document.

Checks and weights are defined in scripts/maturity-score.mjs — the single source of truth this page is generated from. New to the scorecard? See how the maturity score works.

Documentation coverage by spec ​

What the doc-coverage check above actually measures: for every spec, the words of documentation attributed to it via <!-- spec:… --> tags versus the words its evaluated complexity leads us to expect. Complexity is computed from the spec corpus itself: each documentable requirement contributes kind-weight (FR/SR 1, NFR 0.4) × its definition's length relative to the corpus median (34 words), and expected = 40 × complexity, floor 120. The check earns the mean coverage: 56%. Least-documented specs first — each is the next best place to write.

Released under the MIT License.

Copyright © 2026-present Samuel Cardinal