Documentation Template for Quicksight Dashboards

I am actually looking for a documentation template for our Quicksight dashboards. We are looking for showcasing all our dashboards information in our catalog and provide them with enough documentation. In this case, I am looking for some documentation template.

Hi @KoyaLokendarReddy - Welcome to QuickSight community and thanks for posting the question. Can you please provide more details on the documentation template? Are you looking for an export of your dashboard with details or you are looking some standard templates. Please give more context on this as project to project the documentation may vary.

Tagging @Karthik_Tharmarajan @Max_B for their expert advise.

Regards - Sanjeeb

Hi @Sanjeeb2022. Thanks for responding.

Documentation in terms of understanding what the dashboard is, why is it built, what metrics it holds, what are the calculations, ownership, etc… This is similar to the data documentation we do for assets like table and column. I am looking to implement a similar thing for Dashboards as well. But I am not sure what all details we can capture as part of that. So, I am looking for any template which have predefined set of keys(placeholders) where users can add details in predefined format.

Hi @KoyaLokendarReddy - Can you please explore the AWS QuickSight API - Describe dashboard. This will provide a good amount information about Dashboard.

See the below link - describe_dashboard_definition - Boto3 1.26.117 documentation

You can write a custom python script and extract the required detals.

Hope this will help you.

Regards - Sanjeeb