← ClaudeAtlas

dxkit-docslisted

Generate the documentation a repo is missing — read the Documentation dimension's gaps, orient on the real code via the graph, then write a grounded README / docstrings / API + architecture docs that move the score without tripping the slop check. Use when the user says "write docs", "document this module", "improve the documentation score", "generate a README", "add docstrings", or after a health report flags Documentation.
vyuh-labs/dxkit · ★ 2 · Data & Documents · score 68
Install: claude install-skill vyuh-labs/dxkit
# dxkit-docs This skill closes the gap `dxkit-action` doesn't: it **generates** missing documentation rather than fixing flagged findings. It's built around one hard constraint — dxkit's own quality scan flags AI-slop prose, so documentation that reads like generated filler *lowers* the Quality score while raising Documentation. The whole point of this skill is docs that are **grounded in the real code** and **survive the slop check**. ## The docs loop ``` [1] Read the gap → health Documentation deductions + top actions [2] Orient → graph: what are the real entry points, modules, public API [3] Generate → write the missing artifact, grounded in actual symbols/paths [4] De-slop → write like a human; re-run quality so it doesn't trip slop [5] Verify → re-run health; Documentation up, slop not down ``` Don't skip [2] or [4]. [2] is what keeps the docs true; [4] is what keeps them from costing you on another dimension. ## [1] Read the gap — what's actually missing The Documentation dimension scores a fixed checklist. Read its deductions and ranked actions instead of guessing: ```bash npx vyuh-dxkit health --detailed --json | jq '.dimensions.documentation' ``` The `deductions` array names each missing/substandard artifact; `topActions` ranks them by score uplift. The scored artifacts are: | Artifact | What moves the score | |---|---| | **README** | Present, and substantial (not a 5-line stub) | | **Doc-comment density** | Share of source fil