SkillVaultskills Browse all 1,000+ skills

Writing · Version 1.2.0 · Reviewed 2026-08-02

Documentation Quality Scorecard Builder

Make the reader act on documentation quality baseline and documentation gap scoring with evidence, explicit trade-offs, and a verification plan.

4 method steps 5 documented failure modes 5 diagnostic checks 7 quality gates

Evaluates documentation for task completion, correctness, findability, freshness, accessibility, and evidence quality. It grounds the decision in target user tasks, analytics, support failures, source code, navigation, ownership, and last-reviewed evidence and explicitly prevents a polished score hiding that users cannot complete the primary task or that technical claims have drifted.

₹199 one-time

Get this skill archive

Install in your AI coding tool

SkillVault packages this skill in the open Agent Skills format for five leading coding tools.

What this skill helps you do

  • Documentation quality baseline
  • Documentation gap scoring
  • Improvement measurement

How Documentation Quality Scorecard Builder works

You provide

The reader task, current pages, source evidence, navigation, and support or search signals

It inspects

Correctness, findability, and task completion for documentation quality baseline

It decides

A documentation gap scoring change with ownership and a refresh trigger

You verify

A clean reader completes the task and the documentation build validates links, metadata, and examples

What it checks first

Documentation Quality Scorecard Builder evaluates documentation for task completion, correctness, findability, freshness, accessibility, and evidence quality. It grounds the decision in target user tasks, analytics, support failures, source code, navigation, ownership, and last-reviewed evidence and explicitly prevents a polished score hiding that users cannot complete the primary task or that technical claims have drifted. Use it when the work involves Documentation quality baseline, Documentation gap scoring, Improvement measurement.

  1. The user task the document must enable and the observable completion condition, rather than the page type alone.
  2. Technical claims traced to current code, configuration, interfaces, or an accountable decision owner.
  3. Navigation and search language aligned with how readers describe the problem instead of the owning team structure.
  4. Executable examples tested in a clean environment with the same versions and prerequisites the page declares.
  5. Ownership, last-reviewed evidence, and a refresh trigger tied to the source behavior most likely to change.

Failure modes it recognizes

  • A correct page remains undiscoverable because its title and navigation use internal vocabulary readers never search.
  • Setup instructions omit an implicit credential, platform, or working-directory assumption and fail on the first command.
  • Documentation describes the intended architecture while production code follows a later undocumented path.
  • Generated navigation excludes a valid page or keeps a deleted page reachable through stale links.
  • A support answer is copied into documentation without verifying that the workaround remains safe and current.

Answers it will reject

  • Measuring documentation quality by page count, word count, or formatting compliance instead of task success.
  • Mirroring the repository tree as navigation when readers approach the system by goals and failures.
  • Publishing code samples that were syntax-checked but never executed against the stated prerequisites.
  • Adding an FAQ entry for every support question instead of repairing the earliest missing concept or task step.

Decision rules it applies

  • Fix incorrect and task-blocking content before improving completeness, style, or visual polish.
  • Prefer one maintained source for a fact and link to it rather than duplicating volatile instructions across pages.
  • Create a new page only when it owns a distinct reader task or decision and has a durable maintenance owner.
  • Retire content when no current reader journey depends on it or when a maintained source supersedes it completely.

Evidence it asks for

  • Run links, metadata, navigation generation, and representative code examples in the documentation build.
  • Trace support and search queries to the page and section where the reader task currently fails.
  • Test the highest-value journeys from a clean environment using only the published instructions.
  • Diff documented commands, interfaces, and configuration against their defining source at release time.

The method inside

  1. Identify the reader decision before drafting
  2. Lead with the conclusion and strongest evidence
  3. Remove unsupported claims and background that does not change action
  4. Check traceability, ambiguity, and the explicit ask

Deliverables

  • Documentation quality baseline revised draft
  • Documentation gap scoring source and logic check
  • Improvement measurement approval-ready version

Evidence requirements

  • Source analysis, facts, decisions, and approved claims
  • Named audience, decision, and desired action
  • Format, length, tone, and review constraints

Quality gates

  • Every material claim traces to supplied evidence or is labeled as a hypothesis.
  • The response follows the declared deliverable contract.
  • No execution, access, measurement, or verification is invented.
  • Secrets and personal data are redacted rather than repeated.
  • The user receives a concrete independent verification step.
  • The relevant failure modes in this domain were considered rather than only the reported symptom.
  • No listed anti-pattern was recommended as a solution.

Example task

Input

Apply the documentation quality scorecard builder to our current documentation quality baseline work. We need a concrete decision, bounded changes, and evidence that the result is correct.

Expected output

Start with target user tasks, analytics, support failures, source code, navigation, ownership, and last-reviewed evidence. The highest-risk failure is a polished score hiding that users cannot complete the primary task or that technical claims have drifted. Weight correctness and task success above style, and separate missing evidence from confirmed defects. Verify the result by rerunning the same rubric after changes and testing the highest-value task with a representative reader.

Boundaries and compatibility

Ideal for

  • Documentation quality baseline: produce a decision or artifact grounded in supplied evidence.
  • Documentation gap scoring: produce a decision or artifact grounded in supplied evidence.
  • Improvement measurement: produce a decision or artifact grounded in supplied evidence.

Out of scope

  • Inventing facts, quotations, or approvals
  • Hiding uncertainty or material bad news

Agent compatibility

  • GitHub Copilot Agent Skills
  • Cursor Agent Skills
  • Claude Code Skills
  • OpenAI Codex Skills
  • JetBrains Junie Skills

Tool policy: Advisory by default. No tools are assumed. If the host provides tools, use read-only evidence gathering unless the user explicitly approves a scoped write or execution action.