Skip to navigation
ReferenceQuality

Documentation Constraint Evidence in DocsFab

Dev
View as Markdown

The DocsFab documentation quality model treats applicable cross-layer constraints as hard gates. Declaring a constraint does not establish that the documentation passes it. This page records the current evidence boundary for the private, in-development English-language Fern source set. For more information, refer to DocsFab Quality Reference.

Use the matrix by target and evidence, not by aspiration. A constraint applies until an accountable decision establishes that it does not. A partial result or unretained run is not a pass.

Status Definitions

The following table defines each evidence status.

StatusMeaning
Partially evidencedRelevant source evidence exists, but the complete outcome or required approval has not been established.
Not assessedThe constraint applies, but no sufficient target-specific result has been retained.
Not applicableAn accountable decision with rationale establishes that the constraint does not apply. No current row uses this state.

Current Constraint Matrix

The following table lists the current result for each constraint.

ConstraintApplicability and targetCurrent resultEvidenceOwner and next evidence
Accessibility and inclusionApplies to the rendered Fern site and its intended human readers, including applicable keyboard and assistive-technology use.Not assessedThe Documentation Quality in DocsFab page defines the gate, but no target-specific accessibility run is retained.Documentation experience owner: run automated semantic checks, keyboard testing, assistive-technology review, and representative participant testing.
Global and localization readinessApplies before DocsFab claims support for a locale, language, culture, regional format, or multilingual retrieval behavior. The current source target is English.Not assessedNo supported-locale decision, localization test, or multilingual retrieval result is retained.Product and localization owners: declare supported locales and test terminology, formats, layout expansion, translation, and retrieval.
Safety, security, privacy, and data protectionApplies to source retention, credentials, repository operations, generated instructions, previews, and publication.Partially evidencedArchitecture defines authority and secret boundaries. The quickstarts label preview limitations and protect disposable state. No product-security approval or complete adversarial execution result is retained.Security, privacy, and product owners: review threat boundaries, secret handling, retention, generated instructions, dependencies, and deployed surfaces.
Legal, policy, and support complianceApplies before external distribution, supported-product claims, or a production release.Not assessedThe implementation status says public release is blocked. No target-specific licensing, open-source, product-support, or release approval is retained.Legal, open-source, product-security, and support owners: record applicable approvals and support commitments for the release target.
Human-agent representation parityApplies wherever humans render Fern pages and agents retrieve source or indexed representations of the same documentation.Not assessedSource pages have stable titles and no broken relative links, but no source-to-render or human-to-agent semantic parity assessment is retained.Documentation and retrieval owners: compare authoritative claims, scope, warnings, link targets, and version metadata across rendered and retrieved forms.

Interpretation

A Partially evidenced result is not a pass. A Not assessed result preserves an evidence gap instead of converting silence into success. Before a release uses any constraint as a gate, its profile must name the applicable target, required methods, threshold or acceptance rule, evidence locator, and decision owner.

See the following related topics:

Evidence Sources

The matrix draws on the following evidence sources: