agentsclimarketplace
Sign in

Harness docs audit

Skill cekrauseee/harness/skills/harness-docs-audit

Audit versioned developer documentation and HTML artifacts for structure, routing, broken links, size, accessibility, external dependencies, drift, duplication, and Harness boundary violations. Use when reviewing README.md, docs/, module docs, or docs/artifacts, or before publishing documentation changes.From its SKILL.md

Install
npx -y skills add cekrauseee/harness --skill harness-docs-audit

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

  • 0 stars0 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

SKILL.md

2.1 KB, 375 tokens by cl100k_base, as published. Nobody here has run it

Harness Docs Audit

Run deterministic checks first, then review semantic accuracy against the project.

Procedure

  1. Run scripts/check_docs.py <project-root> --strict.
  2. Use --format json when structured findings are useful.
  3. Read docs/index.md, then only files implicated by the findings.
  4. Compare behavior claims with relevant source, tests, configuration, and explicit decisions.
  5. Fix issues when authorized; otherwise report the smallest actionable set.
  6. Re-run the checker after changes.

Review Rules

  • Require the canonical baseline created by harness-docs-init.
  • Route each module document from docs/index.md and each HTML artifact from docs/artifacts/index.md.
  • Keep local Markdown links valid and use one canonical source for each active explanation.
  • Write in simple, objective, coherent, and concise English.
  • Treat size thresholds as prompts to improve routing, not reasons for arbitrary splitting.
  • Verify that diagrams, commands, architecture claims, and module contracts match the project.
  • Keep memory, session state, drafts, investigations, and provisional decisions out of versioned docs.
  • Require artifacts to be final, static, self-contained, accessible HTML with a neutral Harness presentation.
  • Reject project branding, application UI imitation, frameworks, build steps, and external runtime dependencies in artifacts.

Severity

  • Issues fail every run: missing baseline paths, broken local links, invalid artifact structure, external artifact dependencies, or unindexed artifacts.
  • Warnings fail only with --strict: oversized files, unindexed module docs, or maintainability concerns.

Size Guidance

  • README.md: 120 lines.
  • docs/index.md: 100 lines.
  • Macro documents: 220 lines.
  • Module documents: 180 lines.
  • docs/artifacts/index.md: 160 lines.

What ships with it: 2 files

9.1 KB alongside SKILL.md, 1 of them executable

agents/

scripts/

Keep looking

Skills are one crate of 325,949. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.