content-freshness

Analyze Markdown documentation for outdated versions, broken links, and deprecated patterns.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill tracks content freshness across documentation by analyzing version references, technology currency, link validity, and time-sensitive content, helping maintain accurate and reliable docs.

Core Features & Use Cases

  • Version References: Detects version mentions and flags outdated or hard-coded versions.
  • Link Validity: Checks internal and external links for redirects and broken links.
  • Technology Currency: Identifies references to outdated technologies or patterns and suggests updates.
  • Time-Sensitive Content: Highlights phrases like "currently" or dates to guide review needs.
  • Use Case: Run the skill during quarterly doc audits to surface items needing review and publish a maintenance plan.

Quick Start

Use the content-freshness skill to audit docs/**/*.mdx and generate a maintenance report.

Frequently Asked Questions about content-freshness

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

FAQPage Schema
How do I audit markdown documentation for outdated version references and broken links?

To audit markdown documentation for outdated references and broken links, you can use content freshness checks to quantify version mentions, detect deprecated patterns, and report actionable steps for updating content.

What is the best way to keep documentation evergreen during a quarterly maintenance audit?

Keeping documentation evergreen during a quarterly maintenance audit involves analyzing version references, technology currency, link validity, and time-sensitive phrases to surface items needing review and publish a maintenance plan.

How do I check mdx files for deprecated technology patterns and hard-coded versions?

You can check mdx files for deprecated technology patterns and hard-coded versions by running a freshness analysis that scopes to entire sections, flags outdated references, and suggests updates.

Can I identify time-sensitive content like specific dates or the word currently in my docs?

Yes, you can identify time-sensitive content in your docs by analyzing text to highlight phrases like currently or specific dates, which guides review needs and flags outdated references.

What are the limitations of using automated link validity checks for documentation maintenance?

Automated link validity checks for documentation maintenance are limited to evaluating internal and external links for redirects and broken paths, and do not rewrite content or update versions automatically.

Do I need any external dependencies to perform a content freshness audit on my docs?

No external dependencies are required to perform a content freshness audit on your docs, as the skill operates independently to analyze markdown files and generate a structured maintenance report.