docs-page-opening-optimizer

Optimize Elastic documentation page openings with H1, paragraph, and prerequisites.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill ensures that the critical introductory sections of your documentation pages (H1 title, opening paragraph, and requirements) are clear, discoverable, and adhere to Elastic's content standards, improving user comprehension and searchability.

Core Features & Use Cases

  • H1 Optimization: Ensures titles are specific, searchable, and include necessary anchors.
  • Introductory Paragraph Refinement: Crafts compelling opening paragraphs that define the topic and its value without repeating the frontmatter description.
  • Requirements Section Generation: Adds a "Before you begin" section when necessary, detailing prerequisites like privileges or specific data, while excluding obvious or generic requirements.
  • Content Type Adaptation: Tailors optimization strategies based on whether the page is a tutorial, how-to, reference, explanation, or overview.
  • Substitution Enforcement: Replaces hardcoded product names with appropriate Jinja2 substitutes (e.g., {{product.kibana}}).

Quick Start

Use the docs-page-opening-optimizer skill to optimize the introduction of the file 'my-new-doc.md'.

Frequently Asked Questions about docs-page-opening-optimizer

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

FAQPage Schema
How do I optimize Elastic documentation page intros for clarity and discoverability?

To optimize Elastic documentation intros, refine the H1 title for specificity, craft a concise opening paragraph, and add a 'Before you begin' section. This ensures pages align with content type conventions and improve searchability.

What is the best way to write an introductory paragraph for a tutorial or reference doc?

The best way to write an intro paragraph for a tutorial or reference doc is to define the topic and its value without repeating frontmatter descriptions. Tailor the content based on the page classification to ensure it meets reader expectations.

How do I format Elastic product names and UI elements in markdown documentation?

To format Elastic product names and UI elements in markdown, enforce Jinja2 substitutions like `{{product.kibana}}` instead of hardcoded names. This ensures adherence to style guidelines and maintains consistency across documentation pages.

When should I add a 'Before you begin' section to a documentation page?

You should add a 'Before you begin' section when a documentation page requires specific prerequisites like user privileges or data. Exclude obvious or generic requirements to keep the section concise and relevant to the user's setup.

Why does my documentation H1 title need anchors and specificity?

Documentation H1 titles need anchors and specificity to enhance discoverability and align with content type conventions. Specific titles help users find relevant pages through search and navigate directly to the required information.

Can I use content optimization to classify my documentation page type automatically?

Yes, content optimization analyzes your documentation page to classify its type, such as tutorial, how-to, reference, explanation, or overview. This classification then tailors the H1, intro, and requirements optimization strategies.