aem-editorial-guide

Generate editor-friendly authoring guides from AEM component dialogs.

6|3|Updated Mar 21, 2026
One-click install
npx skills add https://github.com/easingthemes/dx-aem-flow --skill aem-editorial-guide
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: aem-editorial-guide
Source: https://github.com/easingthemes/dx-aem-flow/tree/main/plugins/dx-aem/skills/aem-editorial-guide
Command: npx skills add https://github.com/easingthemes/dx-aem-flow --skill aem-editorial-guide

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates the creation of editor-friendly documentation for AEM component dialogs by capturing the UI, summarizing field purposes, and generating a ready-to-publish guide for content authors.

Core Features & Use Cases

  • Open the AEM dialog in the editor, extract the dialog structure, and assemble a clear authoring guide.
  • Produce concise explanations of each field's purpose, dependencies between fields, and typical usage scenarios for editors.
  • Save the generated guide to the spec directory for later review and publishing.

Quick Start

Capture the editorial guide for the specified AEM component dialog and save it to the spec/demo folder.

Frequently Asked Questions about aem-editorial-guide

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

FAQPage Schema
How do I generate documentation for AEM component dialogs?

Generate AEM component dialog documentation by capturing the dialog UI and summarizing field purposes to produce a ready-to-publish authoring guide. The tool extracts all visible fields, dependencies, and behaviors directly from the editor.

What is an editorial guide for AEM authoring workflows?

An AEM editorial guide is editor-friendly documentation explaining component dialog fields, their dependencies, and typical usage scenarios. It helps content authors understand how to properly use new or changed components.

Can I automate authoring guide creation for new AEM components?

Yes, you can automate authoring guide creation for new AEM components by extracting the dialog structure and assembling concise explanations of each field's purpose. The generated guide is saved to the spec directory for review.

Does the AEM dialog documentation capture field dependencies and behavior?

Yes, AEM dialog documentation captures all visible fields, dependencies between fields, and component behaviors. This ensures editors understand how different inputs interact within the authoring interface.

Where are generated AEM editorial guides saved for publishing?

Generated AEM editorial guides are saved to the spec directory as demo artifacts. This location supports frontmatter-based discovery and content generation for later review and publishing.

What's the best way to document AEM component changes for content authors?

The best way to document AEM component changes is to capture the dialog UI and generate concise explanations of field purposes and dependencies. This produces a ready-to-publish authoring guide tailored for editors.