doc-impact

Analyzes MariaDB source changes to determine documentation impact and affected pages.

28|115|Updated Jan 28, 2025
One-click install
npx skills add https://github.com/mariadb-corporation/mariadb-docs --skill doc-impact-mariadb-corporation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-impact
Source: https://github.com/mariadb-corporation/mariadb-docs/tree/main/.claude/skills/doc-impact
Command: npx skills add https://github.com/mariadb-corporation/mariadb-docs --skill doc-impact-mariadb-corporation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writers maintaining MariaDB documentation need to know whether a code change (an MDEV ticket, DOCS ticket, or server PR/commit) is user-facing and which doc pages it affects before drafting anything. This Skill performs that triage step: it reads the actual diff, classifies the user-facing surface, and reports whether docs are needed, which pages to edit, and which claims must be verified. ## Core Features & Use Cases - Source-of-truth analysis: Resolves MDEV/DOCS tickets or GitHub PRs to the exact commit that introduced the change and analyzes the diff, not just ticket prose. - Impact classification: Detects new system variables, SQL syntax, startup options, error messages, behavior changes, and deprecations, then decides YES/NO/MAYBE on documentation need. - Fact-check report skeleton: Writes a triaged report with PENDING claim rows (source file:line @ commit SHA) to an external reports directory for the drafting step to consume. - Use Case: Given "what docs does MDEV-37456 need?", the Skill fetches the ticket, pins the introducing commit in the local MariaDB/server repo, greps the docs for affected symbols, and outputs an impact report naming the exact pages to edit. ## Quick Start Ask the assistant to analyze the documentation impact of MDEV-XXXXX or a given MariaDB server pull request.

Frequently Asked Questions about doc-impact

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check if an MDEV ticket needs documentation?▼

Provide the MDEV key and the Skill fetches the ticket from jira.mariadb.org, locates the commit that introduced the change in the local MariaDB/server repo, and analyzes the diff. It returns a YES, NO, or MAYBE verdict with the affected doc pages and claims to verify.

How to analyze a MariaDB server pull request for doc impact?▼

Pass the GitHub PR or commit ref and the Skill reads the unified diff directly, classifying user-facing surfaces such as system variables, SQL syntax, startup options, and error messages. It then greps the docs tree to name the existing pages that need edits.

Does this Skill edit or draft documentation pages?▼

No, it is analysis-only and never edits, stages, commits, or opens a PR. The only file it writes is a fact-check report skeleton in an external reports directory; drafting is handed off to the doc-from-ticket skill.

What inputs does the doc impact analysis accept?▼

It accepts a DOCS ticket key, an MDEV ticket key, or a github.com/MariaDB/server pull request or commit reference. DOCS tickets are read through the Atlassian MCP connection, while MDEV tickets are fetched from the public jira.mariadb.org.

What happens if the change is internal-only with no user-facing impact?▼

The Skill reports NO docs needed as a valid answer rather than inventing work. It still writes a minimal triaged report recording the decision so the paper trail is preserved for later sessions.