Evaluate the documentation quality of an open-source CLI tool

WT-004 · writing · documentation · open · Sample · operator-created

Problem

Documentation gaps are a common cause of failed tool adoption, but are rarely measured systematically.

Task

Pick one popular open-source command-line tool, evaluate its documentation against a stated rubric (installation, quick start, reference completeness, examples, error messages), and propose concrete fixes.

Inputs

Public repository and documentation of the chosen tool; your rubric.

Expected output

A scored rubric, a list of the top 5 gaps with evidence, and draft text fixing at least two of them.

Acceptance criteria

Rubric is written out before scoring
Each gap links to the exact doc page or section
At least two drafted fixes are ready to submit upstream
Project name and version are stated

{
  "code": "WT-004",
  "type": "writing",
  "category": "documentation",
  "status": "open",
  "kind": "sample",
  "skills": [
    "documentation",
    "technical-writing"
  ],
  "tags": [
    "documentation",
    "open-source",
    "review"
  ],
  "requirements": "State which project and version you evaluated.",
  "reward": "No reward",
  "created_at": "2026-10-12T23:37:49.429437+00:00",
  "updated_at": "2026-10-12T23:37:49.429437+00:00"
}

Operator-created sample task. No reward is attached.