| name | docs-review |
| description | Audit the wazuh-indexer-plugins mdBook documentation (docs/) for coverage gaps, staleness against source code, structural/navigation issues, and style inconsistency. Produces a written findings report — it does not rewrite prose. Use when asked to review, audit, or assess the Wazuh Indexer technical documentation. |
Wazuh Indexer documentation review
Audits wazuh-indexer-plugins/docs/ — the mdBook site covering the Development
Guide and Reference Manual for the Wazuh Indexer ecosystem (Setup, Content
Manager, Security Analytics, Notifications, Alerting, Reporting, Security,
WCS).
This skill produces a findings report, not doc edits. Rewriting is a
separate, later phase, driven by the style guide this skill's output feeds
into (see "Related artifacts" below) — don't fold rewriting into this skill.
Status: a full audit + module-by-module rewrite has already been done
once using this process (Content Manager, Security Analytics, Alerting,
Setup, Notifications, Reporting, Common Utils), including two follow-up
correction passes, plus targeted ad-hoc fixes since (docs/dev/ tree-wide
style sweep, Setup's ISM policy and schema.md corrections, Content
Manager's blue/green swap diagram, the logtest transport-action refactor,
Security Analytics' enrichment performance rewrite). Re-running this skill
now is a regression/drift check
against an already-conforming corpus, not a first pass — expect most
findings to be new drift (new content added since the last pass) or missed
spots, not the original backlog. See "Related artifacts" for what's already
fixed vs. what was intentionally deferred.
Related artifacts
- Style guide:
.claude/skills/docs-review/STYLE_GUIDE.md, checked into
this repo alongside this skill. Produced from a prior run of this skill's
findings; defines the actual rules — heading case, terminology,
register-per-track, table-vs-list, versioning caveats, etc. When this
skill's style/consistency pass (step 4) finds something, check it against
the style guide first: if the guide already has a rule, this is a plain
violation to report; if it doesn't, that's a signal the guide needs a new
rule, not just a one-off fix — propose the addition in the findings report
rather than editing directly (see "Explicitly out of
scope" below).
