release-docs

Scan README, CHANGELOG, FAQs, and plugin.json for release documentation accuracy.

2|Updated May 13, 2026
One-click install
npx skills add https://github.com/miXshift/mx-claude-plugin --skill release-docs-mixshift
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: release-docs
Source: https://github.com/miXshift/mx-claude-plugin/tree/main/.claude/skills/release-docs
Command: npx skills add https://github.com/miXshift/mx-claude-plugin --skill release-docs-mixshift

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill ensures that the customer-facing documentation stays current with the actual features and capabilities of the product, preventing discrepancies and confusion.

Core Features & Use Cases

  • Documentation Accuracy: Checks and updates customer-facing documentation like README, CHANGELOG, FAQs, and more.
  • Release Readiness: Facilitates the process of preparing a release by auditing and updating all necessary documentation.
  • Use Case: Before cutting a release, use this skill to verify that all public-facing documents reflect the latest product capabilities and changes.

Quick Start

Run the 'release-docs' skill to reconcile skill roster and update the customer-facing documentation.

Frequently Asked Questions about release-docs

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

FAQPage Schema
How do I check and update customer-facing documentation to match the shipped release?

To update customer-facing documentation for release readiness, scan README, CHANGELOG, FAQs, and plugin.json files to reconcile them with shipped product capabilities. This requires running npm run check-docs as a preliminary validation step.

What is documentation accuracy for release readiness?

Documentation accuracy for release readiness is the process of auditing public-facing files like README and CHANGELOG to ensure they match actual shipped product features, preventing customer confusion and discrepancies upon release.

How do I reconcile the skill roster before cutting a release?

To reconcile the skill roster before a release, run the release-docs skill to scan and update documentation. This ensures the roster and all public-facing documents accurately reflect the latest product changes.

Do I need npm to verify README and CHANGELOG accuracy?

Yes, you need npm to verify README and CHANGELOG accuracy because the documentation audit requires running npm run check-docs as a preliminary step to successfully validate and update files for release readiness.

What files are scanned during a documentation release readiness audit?

During a documentation release readiness audit, the system scans README, CHANGELOG, FAQs, and plugin.json files to check for accuracy and update them to match the shipped reality of the product.

Why does customer-facing documentation become outdated before a release?

Customer-facing documentation becomes outdated before a release when new features and code changes are implemented without immediately updating the README, CHANGELOG, or FAQs, creating discrepancies between the docs and shipped reality.