← ClaudeAtlas

tenet-docslisted

Audits README/API docs, ADRs, changelog, documentation coverage, and freshness.
inceptyon-labs/tenet-skills · ★ 0 · Code & Development · score 76
Install: claude install-skill inceptyon-labs/tenet-skills
# Tenet Docs — Documentation Quality Audit > Measures the presence, completeness, and freshness of project documentation: README sections, inline doc coverage on public APIs, architectural decision records, and changelogs. ## Purpose Documentation is the load-bearing surface between the code and every future contributor. This skill audits documentation from four angles: 1. **README completeness** — Does the project's front door explain what it is, how to set it up, and how to contribute? 2. **Inline doc coverage** — Are exported/public symbols annotated with JSDoc, docstrings, or equivalent? 3. **ADR/decision log presence** — For non-trivial projects, are architectural decisions recorded? 4. **Changelog presence** — Is there a changelog or equivalent release history? ## Language Support Matrix ```yaml support: native: [typescript, javascript, python] heuristic: [go, rust, java, kotlin, ruby, php, swift, csharp, cpp, c] skip: [yaml, json, css, sql, shell, dockerfile, markdown] ``` - **Native (TS/JS):** JSDoc detection via `/** ... */` comments directly preceding `export` statements. - **Native (Python):** Docstring detection via triple-quoted strings immediately inside `def`/`class` bodies. - **Heuristic (Go, Rust, Java, etc.):** Comment blocks preceding public/exported symbols detected via regex patterns (`//`, `///`, `/* ... */`, `/** ... */`). - **Skip:** Non-code files are not scanned for inline docs (but markdown files are checked as documentation artifacts).