From docs-tools
Reviews documentation drafts for style guide compliance using Vale linting and Red Hat/IBM skills. Edits AsciiDoc or MkDocs files in place for JIRA tickets.
npx claudepluginhub redhat-documentation/redhat-docs-agent-tools --plugin docs-toolsThis skill is limited to using the following tools:
Step skill for the docs-orchestrator pipeline. Follows the step skill contract: **parse args → dispatch agent → write output**.
Performs technical accuracy review of documentation drafts (.adoc/.md) for JIRA tickets by dispatching technical-reviewer agent, outputs confidence-rated report (HIGH/MEDIUM/LOW).
Runs Vale with AsciiDocDITA rules on AsciiDoc files in Red Hat modular docs repos (repo-wide or assembly/topic scope via dita-validate-asciidoc) and fixes violations for 0 errors/warnings.
Proofreads Markdown documents for style violations per guidelines, detects issues excluding code/URLs/frontmatter, proposes fixes, and applies user-approved edits via interactive prompts.
Share bugs, ideas, or general feedback.
Step skill for the docs-orchestrator pipeline. Follows the step skill contract: parse args → dispatch agent → write output.
$1 — JIRA ticket ID (required)--base-path <path> — Base output path (e.g., .claude/docs/proj-123)--format <adoc|mkdocs> — Documentation format (default: adoc)<base-path>/writing/
<base-path>/style-review/review.md
Extract the ticket ID, --base-path, and --format from the args string.
Set the paths:
DRAFTS_DIR="${BASE_PATH}/writing"
OUTPUT_DIR="${BASE_PATH}/style-review"
OUTPUT_FILE="${OUTPUT_DIR}/review.md"
mkdir -p "$OUTPUT_DIR"
Dispatch the docs-reviewer agent with a format-specific prompt.
Agent tool parameters:
subagent_type: docs-reviewerdescription: Review documentation for <TICKET>Prompt (AsciiDoc — --format adoc):
Review the AsciiDoc documentation drafts for ticket
<TICKET>. Source drafts location:<DRAFTS_DIR>/Edit files in place. Do NOT create copies.
For each file:
- Run Vale linting once (use the
lint-with-valeskill)- Fix obvious errors where the fix is clear and unambiguous
- Run documentation review skills:
- Red Hat docs: docs-review-modular-docs, docs-review-content-quality
- IBM Style Guide: ibm-sg-audience-and-medium, ibm-sg-language-and-grammar, ibm-sg-punctuation, ibm-sg-numbers-and-measurement, ibm-sg-structure-and-format, ibm-sg-references, ibm-sg-technical-elements, ibm-sg-legal-information
- Red Hat SSG: rh-ssg-grammar-and-language, rh-ssg-formatting, rh-ssg-structure, rh-ssg-technical-examples, rh-ssg-gui-and-links, rh-ssg-legal-and-support, rh-ssg-accessibility, rh-ssg-release-notes (if applicable)
- Skip ambiguous issues requiring broader context
Save the review report to:
<OUTPUT_FILE>
Prompt (MkDocs — --format mkdocs):
Review the Material for MkDocs Markdown documentation drafts for ticket
<TICKET>. Source drafts location:<DRAFTS_DIR>/Edit files in place. Do NOT create copies.
For each file:
- Run Vale linting once (use the
lint-with-valeskill)- Fix obvious errors where the fix is clear and unambiguous
- Run documentation review skills:
- Content quality: docs-review-content-quality
- IBM Style Guide: ibm-sg-audience-and-medium, ibm-sg-language-and-grammar, ibm-sg-punctuation, ibm-sg-numbers-and-measurement, ibm-sg-structure-and-format, ibm-sg-references, ibm-sg-technical-elements, ibm-sg-legal-information
- Red Hat SSG: rh-ssg-grammar-and-language, rh-ssg-formatting, rh-ssg-structure, rh-ssg-technical-examples, rh-ssg-gui-and-links, rh-ssg-legal-and-support, rh-ssg-accessibility
- Skip ambiguous issues requiring broader context
Save the review report to:
<OUTPUT_FILE>
Note: MkDocs review omits docs-review-modular-docs (AsciiDoc-specific) and rh-ssg-release-notes.
After the agent completes, verify the review report exists at <OUTPUT_FILE>.