菜单
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.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
| name | docs-workflow-pr-analysis |
| description | 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. |
| argument-hint | --pr <url> --repo <path> --ticket <TICKET> --output-dir <path> |
| allowed-tools | Read, Write, Bash, Agent, Glob, Grep |
Orchestrator step skill that wraps understand-pull-request to analyze a specific PR/MR and produce change-specific documentation context.
| Flag | Required | Description |
|---|---|---|
--pr | Yes | PR/MR URL (GitHub or GitLab) |
--repo | Yes | Path to the cloned source repository |
--ticket | Yes | JIRA ticket ID |
--output-dir | Yes | Base output directory (.agent_workspace/<ticket>/pr-analysis/) |
--pr is a valid GitHub or GitLab PR/MR URL--repo directory exists--output-dir if neededYou MUST use the Agent tool to run understand-pull-request in an isolated subagent. Do NOT invoke Skill: understand-pull-request inline — that would load 570+ lines of skill text plus all intermediate orchestration into the main context.
Check if learn-code output exists from a prior code-analysis step:
CODE_ANALYSIS_DIR="$(dirname "${OUTPUT_DIR}")/code-analysis"
ls "${CODE_ANALYSIS_DIR}/ONBOARDING.md" 2>/dev/null
Build the agent prompt with or without learn-code context:
Agent:
description: "Analyze PR: <PR_URL>"
prompt: |
Run the understand-pull-request skill to analyze this PR/MR.
Skill: understand-pull-request, args: "<PR_URL> --repo <REPO>"
[If learn-code analysis exists at CODE_ANALYSIS_DIR:]
Learn-code analysis is available at <CODE_ANALYSIS_DIR>. The skill
will use it for richer module-level context.
After the skill completes, report the location of the output files
(PR-*-ANALYSIS.md and any pr-context.json).
After the agent completes, copy the PR analysis output to the step's output directory:
# Find the understand-pull-request output — it writes to .work/ or the repo's .agent_workspace/
# Look for PR-*-ANALYSIS.md in the agent's output locations
find "${REPO}" -name "PR-*-ANALYSIS.md" -newer "${OUTPUT_DIR}" 2>/dev/null | head -1
Copy the found files:
PR-<N>-ANALYSIS.md — Structured change analysis documentpr-context.json — PR metadata and per-module change data (if produced)If PR-*-ANALYSIS.md is not found after the agent completes, mark the step as failed and report the error.
{
"schema_version": 1,
"step": "pr-analysis",
"ticket": "<TICKET>",
"completed_at": "<ISO 8601>",
"pr_number": "<N>",
"pr_url": "<PR URL>",
"modules_affected": "<count>",
"platform": "github|gitlab"
}
Print summary:
PR analysis complete:
- PR: <url>
- Modules affected: <N>
- Platform: <github|gitlab>
- Output: <output-dir>
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.
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, children, siblings, links), and generate summaries. This skill is read-only and cannot modify JIRA issues. Requires jira and ratelimit Python packages.
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.
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.
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 gap list. Iteration logic is owned by the orchestrator, not this skill.
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.