docs-page-opening-optimizer

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'.