docs-skills

Plugin docs-skills from marketplace opendatahub-skills in opendatahub-io/skills-registry. Commands read from the repo's manifest — 8 days ago.

Skills (52)

• action-comments

  Fetch unresolved review comments from GitHub PRs or GitLab MRs and action them on local files. Works standalone (interactive) or in CI mode (autonomous). Optionally reads .agent_workspace artifacts for grounding. MUST BE USED when the user asks to action, address, or process review comments on a PR/

• article-extractor

  Download HTML from websites and extract article content, removing HTML bloat. Specifically designed to extract content from <article> tags with aria-live="polite" attribute. Outputs clean, readable content for documentation sites like Red Hat docs.

• docs-convert-gdoc-md

  Read a Google Docs document, Google Slides presentation, or Google Sheets spreadsheet and output as Markdown or CSV. Use this skill when asked to read, fetch, import, or convert a Google Doc, Google Slides, or Google Sheets URL.

• docs-orchestrator

  Documentation workflow orchestrator. Reads the step list from .agent_workspace/docs-workflow.yaml (or the plugin default). Runs steps sequentially, manages progress state, handles iteration and confirmation gates. Claude is the orchestrator — the YAML is a step list, not a workflow engine.

• docs-review-content-quality

  Review documentation for content quality — logical flow, user journey alignment, scannability, conciseness, fluff removal, and customer focus. Use this skill whenever someone asks to check if docs are well-organized, too wordy, have unnecessary content, lack logical flow, or need tightening. Also us

• docs-review-modular-docs

  Review AsciiDoc (.adoc) files for Red Hat modular documentation compliance — module types (concept, procedure, reference), assembly structure, anchor IDs, context variables, leveloffset, and include directives. Use this skill whenever someone asks about modular docs, checks .adoc file structure, ask

• docs-review-security

  Scan documentation for sensitive data before publication — real IP addresses, credentials, internal hostnames, email addresses, and MAC addresses. Use this skill when asked to check for PII, security issues, customer-sensitive data, or before publishing documentation. Runs a deterministic regex scan

• docs-review-style

  Multi-agent style guide and modular docs review with confidence scoring. Supports local branch review, PR/MR review with optional inline comment posting, and fix mode. MUST BE USED when the user asks for style guide compliance review, modular docs structure review, content quality checks, or wants t

• docs-review-technical

  Technical accuracy review and code-aware validation with confidence scoring. Supports local branch review, PR/MR review with optional inline comment posting. MUST BE USED when the user asks to validate documentation against code, check technical accuracy, verify commands/APIs/configs in docs match s

• docs-ticket-readiness

  Assess JIRA ticket readiness for the docs-orchestrator workflow. Checks description quality (via LLM), PR/source linkage, metadata completeness, and relationship context (2-level graph traversal). Outputs structured JSON verdict with actionable gaps. Use when you want to check if a JIRA ticket has e

• docs-workflow-code-analysis

  Run code-learner analysis on a source repository for the docs orchestrator workflow. Dispatches a subagent to run learn-code, keeping the heavy orchestration out of the main context. Produces ONBOARDING.md, module registry, per-module summaries, and cross-module relationship data.

• docs-workflow-create-jira

  Create a linked JIRA ticket for documentation work. No agent dispatch. Uses direct JIRA REST API calls via a shell script. Checks for existing links, handles public/private project visibility, converts markdown to JIRA wiki markup.

• docs-workflow-create-merge-request

  Commit, push, and create a merge request (GitLab) or pull request (GitHub) for documentation changes. Creates a feature branch if the repo is on main/master. Replaces docs-workflow-prepare-branch, docs-workflow-commit, and docs-workflow-create-mr.

• docs-workflow-jira-ready

  Check whether a JIRA query returns tickets ready for the docs workflow. Queries JIRA via jira_reader.py, filters out tickets that already have a workflow progress file or a "docs-workflow-started" label, and outputs a JSON list of actionable ticket IDs. Designed as the entry point for cron-triggered

• docs-workflow-pipeline-diagnostics

  Diagnose a docs-orchestrator pipeline run for failures, bottlenecks, and context-pressure risks. Runs the diagnostics script, drills into failures, and writes a diagnostic report with actionable recommendations.

• docs-workflow-planning

  Create a documentation plan from requirements analysis output. Dispatches the docs-planner agent. Invoked by the orchestrator.

• docs-workflow-pr-analysis

  Run PR/MR analysis for the docs orchestrator workflow. Dispatches a subagent to run understand-pull-request, keeping the heavy orchestration out of the main context. Produces a structured PR-ANALYSIS.md. Conditional on has_pr — skipped when no PR URL is available.

• docs-workflow-quality-gate

  Score documentation quality and intent alignment using LLM judge agents (Opus). Dispatches two judge agents in parallel (doc_quality, intent_alignment), extracts specific gaps from AC coverage analysis, and cross-references against scope-req-audit evidence. Produces pass/fail gate with actionable ga

• docs-workflow-requirements

  Analyze documentation requirements for a JIRA ticket using a two-pass fanout. Pass 1 dispatches a discovery agent to enumerate requirements. Pass 2 fans out one deep-analysis agent per requirement for isolated, thorough analysis. Assembles the standard requirements.md output. Invoked by the orchestr

• docs-workflow-scope-req-audit

  Classify JIRA requirements by code evidence status before planning. Uses learn-code analysis data and source code inspection to determine if each requirement is grounded, partial, or absent. Fans out one subagent per requirement for isolated classification. Prevents hallucinated documentation for un

• docs-workflow-security-review

  Security and PII scan of documentation drafts before publication. Runs the deterministic PII scanner, then applies the docs-review-security checklist for agent-based analysis. Iteration logic is owned by the orchestrator, not this skill.

• docs-workflow-start

  Interactive guided setup for the docs workflow. Only invoke this skill when the user explicitly requests docs-workflow-start (e.g., /docs-workflow-start). Do NOT invoke this skill when the user requests docs-orchestrator — that skill runs directly. When invoked with no CLI switches, uses AskUserQues

• docs-workflow-style-review

  Style guide compliance review of documentation drafts. Dispatches the docs-reviewer agent with Vale linting and 18+ style guide review skills.

• docs-workflow-tech-review

  Technical accuracy review with optional code-learner claim validation. Iteration logic owned by the orchestrator.

• docs-workflow-writing

  Write documentation from a documentation plan. Dispatches the docs-writer agent. Supports AsciiDoc (default) and MkDocs formats. Default placement is UPDATE-IN-PLACE; use --draft for staging area. Also supports fix mode for applying technical review corrections.

• git-pr-reader

  Unified interface for GitHub PRs and GitLab MRs: read PR/MR data with file filtering, list changed files, get review comments, post inline review comments, reply to existing comment threads, extract line numbers from diffs, validate comments, auto-detect PR/MR for current branch, and get unified dif

• ibm-sg-audience-and-medium

  Review documentation for IBM Style Guide audience and medium issues — accessibility (alt text, color, headings), global audience readiness (idioms, date formats, cultural references), tone (active voice, no "please" or "simply"), AI assistant style, marketing claims, and mobile/video content. Use th

• ibm-sg-language-and-grammar

  Review documentation for IBM Style Guide language and grammar — abbreviations/acronyms, capitalization, active voice, inclusive language (master/slave, blacklist/whitelist, gendered pronouns), contractions, anthropomorphism, and preferred terminology (avoid "utilize," "leverage," "via," "in order to

• ibm-sg-legal-information

  Review documentation for IBM Style Guide legal issues — unsubstantiated claims, superlatives, trademarks (™/® usage), copyright notices, personal information (PII in examples), and republishing/attribution of external content. Use this skill when checking for legal risks, trademark compliance, PII e

• ibm-sg-numbers-and-measurement

  Review documentation for IBM Style Guide number and measurement formatting — numerals vs. spelled-out numbers, commas in large numbers, currency codes (USD/EUR), date formats, 24-hour time, units of measurement (KB/MB/GB with spaces), IEC binary prefixes (KiB/MiB/GiB), and phone numbers. Use this sk

• ibm-sg-punctuation

  Review documentation for IBM Style Guide punctuation — serial/Oxford commas, colons before lists, em dashes vs. en dashes vs. hyphens, compound adjective hyphenation, quotation marks (US style), semicolon avoidance, ellipses, exclamation points, parentheses, slashes ("and/or"), and period consistenc

• ibm-sg-references

  Review documentation for IBM Style Guide reference issues — citations, footnotes, geographic locations, product and service names (official capitalization, trademark usage), product version formatting ("version 4.12 and later" not "recent versions"), and name/title conventions. Use this skill when c

• ibm-sg-structure-and-format

  Review documentation for IBM Style Guide structure and format — headings (sentence case, no gerunds), lists (parallel structure, lead-in sentences), procedures (imperative verbs, one action per step, max 9 steps), tables (headers, alignment, captions), notes/warnings/tips, bold/monospace/italic form

• ibm-sg-technical-elements

  Review documentation for IBM Style Guide technical elements — code examples (language tags, realistic values, RFC 2606/5737 addresses), command-line formatting (prompts, line continuation), command syntax notation, file names/paths (monospace), keyboard keys (bold, Ctrl+C), menus (bold, File > Save)

• jira-reader

  Read and analyze JIRA issues from Red Hat Issue Tracker. Use this skill to fetch issue details, search issues, extract comments and discussions, categorize issues (bugs, CVEs, features, stories), analyze custom fields (release notes, fix versions), retrieve Git links, traverse ticket graphs (parent,

• jira-writer

  Update and modify JIRA issues on Red Hat Issue Tracker. Use this skill to push release notes, update custom fields (release note content, status), manage labels (add/remove), and modify issue properties. This skill performs write operations and will prompt for user approval before making changes. Re

• learn-code

  Analyze a codebase for engineer onboarding. Detects language, maps modules, analyzes each module in parallel, discovers cross-module relationships, and produces an ONBOARDING.md guide.

• lint-with-vale

  Run Vale linting to check for style guide violations. Supports Markdown, AsciiDoc, reStructuredText, HTML, XML, and source code comments. Use this skill when asked to lint, check style, or validate documentation.

• mdita-write

  Write Markdown DITA topics and maps, then convert to DITA XML using DITA-OT with the org.lwdita plugin. Use when asked to create DITA documentation, write Markdown DITA topics, generate concept/task/reference content, create DITA maps, or convert Markdown to DITA XML.

• query-code

  Answer questions about a previously analyzed codebase. Reads learn-code output and dispatches an agent that can also Read/Grep the actual source code to provide file:line-grounded answers.

• redhat-docs-toc

  Extract distinct article URLs from Red Hat documentation table of contents pages. Parse the TOC navigation to find all separate documentation articles. Useful for crawling and processing multi-page Red Hat documentation.

• rh-ssg-accessibility

  Review Red Hat documentation for accessibility compliance (WCAG) — alt text for images/icons, color not as sole information carrier, no directional language ("left"/"right"/"above"), descriptive link text (no "click here"), table structure (no irregular headers, no blank header cells), and correct h

• rh-ssg-formatting

  Review Red Hat documentation for SSG formatting compliance — code blocks (one command per step, bold via subs="+quotes", separate input/output), user-replaced values (angle brackets, italics, underscores), sentence-style capitalization in titles, product name/version attributes (not hard-coded), dat

• rh-ssg-grammar-and-language

  Review Red Hat documentation for SSG grammar and language compliance elements like conscious language (no blacklist/whitelist, no master/slave), no contractions in product docs, conversational style levels, minimalism principles (action-oriented, scannable, concise), animate vs. inanimate user prono

• rh-ssg-gui-and-links

  Review Red Hat documentation for SSG graphical interface and link compliance for elements like UI element formatting (bold text, correct verbs such as click/select/enter), screenshot guidelines, text entry (enter not type), cross-reference format (xref), external link rules (no bare URLs, no shorten

• rh-ssg-legal-and-support

  Review Red Hat documentation for SSG legal and support compliance — no cost/pricing references, no future release promises, Developer Preview requirements and Technology Preview requirements. Use this skill when checking Red Hat docs for Technology Preview, Developer Preview, TP/DP admonitions, cost

• rh-ssg-release-notes

  Review Red Hat release notes for SSG compliance — tense rules (present default, past for before this update), informative headings (sentence case, no gerunds, under 120 chars), Jira references on known/fixed issues, AsciiDoc formatting (description lists, + attachment), and release note types such a

• rh-ssg-structure

  Review Red Hat documentation for SSG structural compliance — admonitions (NOTE/IMPORTANT/WARNING/TIP only, no CAUTION, no clustering, modules never start with admonitions), lead-in sentences (only when needed after Prerequisites/Procedure headings), prerequisites (written as completed states not imp

• rh-ssg-technical-examples

  Review Red Hat documentation for SSG technical example compliance — root privilege commands, YAML ellipses, IP addresses (RFC 5737 for IPv4, RFC 3849 for IPv6), MAC addresses (RFC 7042), code block quality (accurate, copy-paste friendly), and syntax highlighting. Use this skill when checking Red Hat

• rn-known-issues

  Check known issue status for a release version. Shows which known issues are still open (document in Known Issues) and which are resolved (move to Fixed Issues or remove). Use when asked to check known issues, audit release notes known issues, or find resolved known issues for a version.

• understand-pull-request

  Analyze a pull request or merge request. Fetches PR metadata via git-pr-reader, identifies affected modules, analyzes changes in context, and produces a PR-ANALYSIS.md document with a brief repo overview and detailed change analysis.

• validate-plugin-prereqs

  Check that all environment variables and CLI tools required by the docs-skills plugin are available. Use when setting up a new environment, troubleshooting missing prerequisites, or before running a workflow for the first time.

Subagents (16)

• code-questioner

  Answers questions about an analyzed codebase using learn-code output and direct source code inspection. Provides file:line-grounded answers.

• docs-planner

  Use PROACTIVELY when planning documentation structure, performing gap analysis, or creating documentation plans. Analyzes requirements, applies JTBD framework, and creates comprehensive documentation plans. MUST BE USED for any documentation planning or content architecture task.

• docs-reviewer

  Use PROACTIVELY when reviewing documentation for style guide compliance. Uses Vale linting and 18 style guide review skills (IBM Style Guide + Red Hat SSG) to review AsciiDoc files, edit in place, and generate review reports. MUST BE USED for any style review or documentation quality check.

• docs-writer

  Use PROACTIVELY when writing or drafting documentation. Creates complete CONCEPT, PROCEDURE, REFERENCE, and ASSEMBLY modules in AsciiDoc (default) or Material for MkDocs Markdown format. MUST BE USED for any documentation writing, drafting, or content creation task.

• module-analyzer

  Deep analysis agent for a single codebase module. Receives full source and a targeted question. Returns structured JSON with purpose, public API, dependencies, data flow, gotchas, and onboarding priority.

• pr-change-analyzer

  Analyzes the changes a pull request makes to a single module. Receives module source, diffs, and PR context. Returns structured JSON with change purpose, impact, and risks.

• pr-repo-summarizer

  Produces a brief overview of a repository's purpose and architecture. Used when no prior learn-code analysis exists.

• pr-synthesis-writer

  Combines PR metadata, repo overview, and per-module change analyses to produce a PR-ANALYSIS.md document.

• relationship-analyzer

  Analyzes the relationship between two codebase modules. Receives source of module A and API surface of module B. Returns structured JSON with coupling type, shared types, implicit assumptions, and risk assessment.

• repo-mapper

  Maps a codebase by analyzing detection data and config files to produce a per-module registry with tailored analysis questions. One orchestrator call — does not read source code.

• requirement-classifier

  Classifies a single documentation requirement by code evidence status. Receives learn-code analysis context, searches source code with Read/Grep for evidence, and returns structured JSON classification with gap analysis.

• requirements-analyst

  Deep analysis agent for a single documentation requirement. Receives one requirement skeleton from the discovery pass, fetches detailed source content (JIRA, PRs, specs), performs web search expansion, and returns structured JSON with full requirement details including acceptance criteria and refere

• requirements-discoverer

  Lightweight discovery agent for requirements analysis pass 1. Performs JIRA traversal, PR listing, and spec identification to produce a structured JSON skeleton of requirements. Does NOT perform deep analysis, web search expansion, or acceptance criteria writing — those belong to the per-requirement

• security-reviewer

  Use PROACTIVELY when reviewing documentation for sensitive data that a regex scanner cannot catch — customer-identifying names in examples, internal references, real person or organization names, and unsafe placeholder values. MUST BE USED for the agent-analysis layer of a documentation security and

• synthesis-writer

  Combines all module summaries and relationship data to produce the final ONBOARDING.md onboarding guide. One synthesis call.

• technical-reviewer

  Use PROACTIVELY when reviewing documentation for technical accuracy. Reads docs as a developer or architect consumer to catch issues that style-focused review misses — broken code examples, missing prerequisites, incorrect commands, false architectural claims, and absent failure paths. MUST BE USED

Similar plugins