Searching AEM Documentation

Search AEM Live documentation and return ranked results with relevance scores.

Updated Feb 15, 2024
One-click install
npx skills add https://github.com/shsteimer/shsteimer-com --skill searching-aem-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Searching AEM Documentation
Source: https://github.com/shsteimer/shsteimer-com/tree/main/.claude/skills/docs-search
Command: npx skills add https://github.com/shsteimer/shsteimer-com --skill searching-aem-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Navigating extensive documentation can be time-consuming and frustrating, especially when general web searches yield irrelevant results. This skill provides a targeted, efficient way to search official AEM Edge Delivery documentation, ensuring you find precise answers quickly.

Core Features & Use Cases

  • Targeted Documentation Search: Efficiently queries aem.live documentation (docs and blog posts) using specific keywords, filtering out irrelevant web content.
  • Relevance Scoring & Snippets: Presents results sorted by relevance, including descriptions and content snippets to quickly assess usefulness.
  • Deprecation Warnings: Automatically identifies and alerts you to deprecated features, guiding you towards current best practices.
  • Use Case: When you need to understand "block decoration" in AEM, use this skill to get direct links to the most relevant official documentation pages, saving you from sifting through countless search engine results.

Quick Start

Example: Search for block decoration information

node .claude/skills/docs-search/scripts/search.js block decoration

Example: Search for metadata, returning all results

node .claude/skills/docs-search/scripts/search.js --all metadata

Frequently Asked Questions about Searching AEM Documentation

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

FAQPage Schema
How do I search AEM Live documentation efficiently?

Search AEM Live documentation using targeted keywords to query official docs and blog posts. The skill returns ranked results with relevance scores, descriptions, and content snippets, filtering out irrelevant web results and helping you find precise answers quickly.

Can I identify deprecated features in AEM documentation?

Yes, the search automatically detects and alerts you to deprecated AEM features within official documentation, guiding you toward current best practices and ensuring your implementations use supported approaches.

What should I do before searching AEM documentation for implementation guidance?

Check your project codebase and perform limited web searches first to narrow your question. Then use targeted AEM documentation search with specific keywords to locate relevant implementation guidance and validation for your approach.

How do I get the most relevant AEM documentation results?

Use specific keywords related to your task—such as 'block decoration' or 'metadata'—and the search returns results ranked by relevance with direct links to official aem.live pages, saving time versus general search engines.

What output does AEM documentation search provide?

Documentation search returns a ranked set of results including page path, title, description, content snippet, content type, deprecation status, and relevance score, enabling you to assess usefulness and fetch full content as needed.

Why should I use targeted AEM documentation search instead of general web search?

Targeted AEM documentation search queries only official aem.live resources, eliminating irrelevant results from general web searches and delivering precise answers directly from authoritative Edge Delivery documentation.