Documentation Testing Patterns FAQs

Question 1

Can this skill test code examples inside Markdown?

Accepted Answer

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.

Question 2

What is the documentation testing pyramid?

Accepted Answer

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.

Question 3

How does it handle prose style enforcement?

Accepted Answer

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.

Question 4

How do I identify stale documentation?

Accepted Answer

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.

Question 5

What tools are used for link checking?

Accepted Answer

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

主要功能

使用场景

Documentation Testing Patterns

主要功能

使用场景