authoring-guide

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.

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.

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.

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.

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.

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.