Harness docs audit
File-native project continuity and engineering standards for coding agents.
npx -y skills add cekrauseee/harness --skill harness-docs-auditAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
2 things to look at
- 23 days oldThe repository was created 23 days ago. New is not bad, but a brand new repository carrying a familiar-sounding name is the shape a typosquat arrives in, and there has been no time for anyone else to find a problem with it.
- 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.
What its author says it does
Copied from the file, not written here
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.
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
- Run
scripts/check_docs.py <project-root> --strict. - Use
--format jsonwhen structured findings are useful. - Read
docs/index.md, then only files implicated by the findings. - Compare behavior claims with relevant source, tests, configuration, and explicit decisions.
- Fix issues when authorized; otherwise report the smallest actionable set.
- Re-run the checker after changes.
Review Rules
- Require the canonical baseline created by
harness-docs-init. - Route each module document from
docs/index.mdand each HTML artifact fromdocs/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/
- openai.yaml267 B
scripts/
- check_docs.pyruns8.9 KB