Tool to generate authoring docs for Content Fragment Model

Question

Hello Team,

For my project, I need to create many content fragment models. Once I create all these CFM, I need to create implementation guide (for developers) and authoring guide for AEM authors to refere these docs while creating the CF.

Wanted to know, is there any tool to generate implementation guide as well as authoring guide from Content fragment model xml file?

cc @arunpatidar @santoshsai @giuseppebaglio @hrishikeshkagne

Thanks in advance

VishalKa5 · Accepted Answer

Hi @mahesh_gunaje ,

Currently, there is no official Adobe tool that automatically generates detailed implementation and authoring guides directly from a Content Fragment Model (CFM) XML file. However, there are some helpful resources and tools that can assist in streamlining the process:

AEM Content Fragment Generator (VS Code Extension) – This tool helps developers visually create Content Fragment Models and generates the necessary .content.xml files. While it doesn't produce full documentation, it simplifies model creation and provides a clear structure that can be used as a base for writing guides manually. It’s especially useful for developers during the implementation phase. You can find it on the Visual Studio Marketplace. [marketplac...studio.com]
Adobe Experience League Documentation – Adobe provides comprehensive documentation for both creating Content Fragment Models and authoring Content Fragments. These can serve as reference material when drafting your own implementation and authoring guides. [experience....adobe.com] [experience....adobe.com]

Thanks,

Vishal kakde

giuseppebaglio · Answer

hi @mahesh_gunaje,AFAIK, there is no out-of-the-box tool designed to automatically generate implementation guides or authoring guides from Content Fragment Model XML files in AEM. I see two possible approaches here: manual and programmatic. You could create standardized documentation templates that include:For Implementation Guides:Model path and configuration locationData type definitions for each fieldProperty names and validation rulesGraphQL query examplesFragment reference relationships​For Authoring Guides:Field labels and descriptionsRequired vs. optional fieldsCharacter limits and validation requirementsVisual examples of completed fragmentsUsage guidelines for variations​ Alternatively, you could develop a custom documentation generator. This would involve creating a Java or Node.js script that reads CFM XML files from /conf/<project>/settings/dam/cfm/models/, parses the structure, and outputs documentation in your desired format.

Sign up

Login with SSO

Login to the community

Login with SSO

Scanning file for viruses.

This file cannot be downloaded