OOTB Documentation for AEM Components | AEM 6.5 | AEMaaCs | AEM Community Blog Seeding

OOTB Documentation for AEM Components | AEM 6.5 | AEMaaCs by aemsimplifiedbynikhil

Abstract

As we work on different modules and components in AEM project we end up creating the Component Documentation and hosting it on client’s Confluence or other Documentation tools. Those documents contains technical details like how to configure the module to show certain functionality so that it is easy for new developers to understand the use case of the component.

Usually, we see the help (?) icon on the component dialog which redirects to the help path of respective Adobe’s AEM Documentation . Let’s see how we can provide the documentation for our custom component or existing OOTB extended components.

You can find the list of components at:

Go to AEM Start Menu > Tools > General > Select Component Option. (http://localhost:4502/libs/wcm/core/content/sites/components.html)
Click on any of the components. which will show the component information on with following tabs.
Properties — Title, Group, Description, Resource Type, etc.
Policies — Show the mapping of component policies based on templates.
Live Usage — It shows the page path where a component has been configured.
Documentation – We will use the OOTB Documentation feature to add this Tab.
I am going to use the Accordion Component to record the Documentation.

Read Full Blog

OOTB Documentation for AEM Components | AEM 6.5 | AEMaaCs

Q&A

Please use this thread to ask the related questions.