docs-content-type-checker

Validate Elastic documentation pages against content type guidelines.

71|10|Updated Aug 20, 2025
One-click install
npx skills add https://github.com/elastic/elastic-docs-skills --skill docs-content-type-checker
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-content-type-checker
Source: https://github.com/elastic/elastic-docs-skills/tree/main/skills/authoring/content-type-checker
Command: npx skills add https://github.com/elastic/elastic-docs-skills --skill docs-content-type-checker

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Ensures that Elastic documentation pages adhere to established content type guidelines, improving consistency and quality across the documentation.

Core Features & Use Cases

  • Content Type Detection: Identifies the intended content type (overview, how-to, tutorial, etc.) from frontmatter or by inference.
  • Guideline Validation: Checks pages against specific requirements, recommended sections, and best practices for each content type.
  • Use Case: Before publishing a new how-to guide, use this skill to verify it includes prerequisites, numbered steps, and a clear "next steps" section, as required by the how-to content type.

Quick Start

Use the docs-content-type-checker skill to check the content type compliance of the file at docs/tutorials/new-feature.md.

Frequently Asked Questions about docs-content-type-checker

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

FAQPage Schema
How do I validate Elastic documentation pages against content type guidelines?

To validate Elastic documentation pages against content type guidelines, use this skill to analyze frontmatter and page structure. It checks compliance with required elements and recommended sections for overviews, how-tos, tutorials, troubleshooting, and changelogs.

What is documentation content type validation and when do I need it?

Documentation content type validation ensures docs adhere to established guidelines for specific formats like overviews or tutorials. You need it before publishing to improve consistency across Elastic documentation by verifying required sections and best practices.

Does the content type checker work with markdown frontmatter for how-to guides?

Yes, the content type checker works with markdown frontmatter for how-to guides. It detects the intended content type from frontmatter or by inference, then verifies the page includes prerequisites, numbered steps, and next steps as required.

What's the best way to check if a tutorial complies with Elastic docs standards?

The best way to check if a tutorial complies with Elastic docs standards is to run this skill against the file. It retrieves official content type documentation and templates using web fetching and MCP tools to compare page structure and frontmatter.

Why does my troubleshooting page fail content type validation?

Your troubleshooting page fails content type validation when it lacks required elements, recommended sections, or best practices defined by Elastic guidelines. The skill identifies the content type from frontmatter and checks for missing structural compliance.