authoring-guide

Name: authoring-guide
Availability: InStock
Author: aramark-destinations

Create author-facing EDS block guides for Universal Editor from UE JSON schema.

Updated Aug 23, 2026

Search Tags:#documentation #content #authoring #blocks #cms #universal-editor

Ready to run

npx skills add https://github.com/aramark-destinations/aramark-mb --skill authoring-guide

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: authoring-guide
Source: https://github.com/aramark-destinations/aramark-mb/tree/main/.agents/skills/eds/authoring-guide
Command: npx skills add https://github.com/aramark-destinations/aramark-mb --skill authoring-guide

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Author-facing documentation is often conflated with developer docs, leading content authors to struggle with how to use EDS blocks in Universal Editor. This guide clarifies the separation and provides clear field explanations, usage guidance, and examples tailored for non-technical readers.

Core Features & Use Cases

Field-level explanations for the UE JSON schema, mapped to plain-English labels.
Author guidance on adding, configuring, and validating blocks within the Universal Editor.
Accessibility and content guidance including image/text recommendations and best practices for authors.

Quick Start

Create an author-facing guide by reading the block's UE JSON schema and the block README, then draft a concise author-facing document following the provided structure and examples.

Frequently Asked Questions about authoring-guide

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

FAQPage Schema

How do I create author-facing documentation for EDS blocks in Universal Editor?▼

To create author-facing documentation for EDS blocks, read the block's Universal Editor JSON schema and README, then draft concise guides explaining fields, usage scenarios, accessibility notes, and content examples for non-technical authors.

Why do content authors struggle with EDS block documentation?▼

Content authors struggle with EDS block documentation because it is often conflated with developer docs. Separating author-facing guidance from technical content provides clear field explanations and usage examples tailored for non-technical readers.

What should be included in author guides for Universal Editor blocks?▼

Author guides for Universal Editor blocks should include plain-English field-level explanations mapped from the UE JSON schema, guidance on adding and configuring blocks, accessibility recommendations, and content examples.

Can I use existing block READMEs to generate content author documentation?▼

Yes, you can use existing block READMEs alongside the UE JSON schema to generate content author documentation. They provide the technical foundation needed to draft accurate field explanations and usage guidance for authors.

Does author-facing documentation need to follow the Universal Editor JSON schema?▼

Yes, author-facing documentation must follow the Universal Editor JSON schema. Aligning with the schema ensures field-level explanations accurately map to plain-English labels and match the actual configuration options available.

What is the best way to separate developer content from author guidance in a CMS?▼

The best way to separate developer content from author guidance in a CMS is to create distinct author-facing documents that extract field explanations, usage scenarios, and accessibility notes, leaving technical implementation details in the developer README.