Can this skill test code examples inside Markdown?

Yes, it uses Python's doctest module and pytest-doctest-glob to execute and verify that code snippets in your documentation produce the expected output.

What is the documentation testing pyramid?

The documentation testing pyramid is a strategy that layers fast, automated checks (like prose style and formatting) at the base, followed by slower integration checks (like external links), and periodic manual E2E reviews at the top.

How does it handle prose style enforcement?

It leverages Vale, a prose linter, to check text against professional style guides like Google or Microsoft, and allows for custom rules to flag vague language or incorrect product spelling.

How do I identify stale documentation?

The skill includes automated freshness detection patterns that use git history and version grep commands to find files that haven't been updated in a specific timeframe or reference outdated versions.

What tools are used for link checking?

The skill provides patterns for tools like lychee, including configuration for handling 429 rate limits, following redirects, and excluding development-only URLs like localhost.

Documentation Testing Patterns

Name: Documentation Testing Patterns
Author: HermeticOrmus

byHermeticOrmus

0•

学習とドキュメンテーション

Implements automated testing frameworks for technical documentation, including code verification, link checking, and prose style enforcement.

This skill provides Claude with sophisticated patterns for treating documentation as code, applying software testing principles to technical guides and READMEs. It enables Claude to implement a 'Documentation Testing Pyramid' that covers everything from unit-level prose linting with Vale and markdownlint to integration-level link validation and E2E manual reviews. By integrating Python doctests directly into Markdown and setting up automated freshness audits, this skill ensures that code examples never rot and documentation remains a reliable source of truth for users and developers alike.

主な機能

01Vale prose linting for Google and Microsoft style guides

020 GitHub stars

03Stale content and code example freshness detection

04Python doctest integration for verifying Markdown code blocks

05Automated external link validation with smart retry logic

06Multi-layered documentation testing pyramid implementation

ユースケース

01Setting up CI/CD pipelines that fail when documentation code examples are broken

02Enforcing consistent brand voice and technical terminology across a documentation site

03Auditing large repositories for broken internal anchors and external URLs

主な機能

01Vale prose linting for Google and Microsoft style guides

020 GitHub stars

03Stale content and code example freshness detection

04Python doctest integration for verifying Markdown code blocks

05Automated external link validation with smart retry logic

06Multi-layered documentation testing pyramid implementation

ユースケース

01Setting up CI/CD pipelines that fail when documentation code examples are broken

02Enforcing consistent brand voice and technical terminology across a documentation site

03Auditing large repositories for broken internal anchors and external URLs