skills.rest
hashicorp
hashicorpOFFICIAL
Explore all skills by this author →
WebsiteGitHub

compare-docs

Compare MDX or Markdown documentation files to identify structural, content, and style gaps.

78|252|Updated Feb 7, 2024
Search Tags:#style#content#quality#structure#docs#recommendations#compare
One-click install
npx skills add https://github.com/hashicorp/web-unified-docs --skill compare-docs-hashicorp
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: compare-docs
Source: https://github.com/hashicorp/web-unified-docs/tree/main/content/well-architected-framework/docs/.claude/skills/compare-docs
Command: npx skills add https://github.com/hashicorp/web-unified-docs --skill compare-docs-hashicorp

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams quickly identify gaps, inconsistencies, and quality gaps between two documentation files.

Core Features & Use Cases

  • Quality scoring and gap detection across structure, content, and style.
  • Side-by-side comparison to surface missing sections, broken links, tone differences, and cross-references.
  • Actionable recommendations to bring doc pairs in line with a chosen baseline.

Quick Start

Use the compare-docs command to compare two docs, for example: /compare-docs docs/modules.mdx docs/workflows.mdx You can specify a baseline with --baseline 2, or focus on resources with --focus resources.

Frequently Asked Questions about compare-docs

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

FAQPage Schema
How do I compare two markdown files to find documentation gaps?▼

You can compare markdown files by running the compare-docs command on any pair of MDX or Markdown files to quantify quality differences, surface missing sections, and identify style discrepancies.

Can I use a specific documentation file as a quality baseline for comparison?▼

Yes, you can specify a baseline file for comparison by using the --baseline flag, which allows the tool to provide actionable recommendations to bring the other document in line with the chosen baseline.

What documentation quality metrics are checked when comparing docs?▼

When comparing docs, the tool evaluates structural metrics, content quality indicators, and style differences to surface missing sections, broken links, tone variations, and cross-reference issues.

Does the documentation comparison tool support focusing on specific sections like resources?▼

Yes, the tool supports focusing on specific sections such as resources by using the --focus flag, allowing you to narrow the gap detection and comparison scope to targeted areas within the MDX or Markdown files.

What is the best way to align inconsistent documentation across different modules?▼

The best way to align inconsistent documentation across modules is to use a side-by-side comparison tool that detects quality gaps and provides actionable recommendations to bring doc pairs in line with a chosen baseline.

Related Skills

Explore More Content & Communication Skills→
williamzujkowskiwilliamzujkowski
17

broken-reference

Scan Markdown files for broken cross-references and report remediation steps.

Community
Basic
Andamio-PlatformAndamio-Platform
5

assess-slts

Evaluate Student Learning Targets across five quality dimensions and generate rewrite suggestions.

Official
Intermediate
gnektgnekt
3.4k

vault-audit

Audit Obsidian vaults across seven phases for structure, links, and frontmatter.

Community
Advanced
BennettPhilBennettPhil

md-link-checker

Validate local file references and remote URLs in Markdown files.

Community
Intermediate