Technical Documentation Overview
The Technical Documentation feature allows you to automatically generate a complete, structured technical document for a Qlik Sense application directly from the repository. This includes metadata, script details, fields, master items, visualizations, bookmarks, stories, and more. This feature helps developers, analysts, and administrators quickly understand the internal structure of the app without manually documenting it.
Availability Criteria
Technical Documentation is available under the following conditions:
- Supported only on the master branch
- Available only for the latest commit
- Not available for older commits or alternate branches
- Requires existing application data in the selected commit
Key Benefits
- Generates documentation directly from the live application, ensuring up-to-date and reliable details.
- Saves time by eliminating manual documentation processes.
- Provides clear visibility into scripts, fields, and objects for faster understanding.
- Supports auditing, troubleshooting, onboarding, and knowledge sharing.
- Enhances code review quality by revealing all underlying technical components.
Steps to Generate Technical Documentation
Step 1: Sign in to the Code Management platform and navigate to the Repositories page where all repositories are listed.
Step 2: Click on the repository for which you want to generate documentation. Navigate to the Commits tab.
Step 3: Ensure you are viewing the master branch. Select the latest commit from the commit list.
Step 4: In the Action column of the latest commit, click the three dots (⋮) to open the dropdown menu. Choose Documentation.
Step 5: After clicking Documentation, a new page will open displaying the automatically generated technical document for the selected commit.
This document includes:
- Application metadata
- Script sections
- Fields overview
- Variables
- Master items
- Sheets and visualizations
- Bookmarks
- Stories & snapshots
- Extensions used
Step 6: You can navigate through different tabs (General Information, Script, Fields, etc.) using the header menu at the top of the documentation page.
Step 7: If needed, click Go to App within the documentation to open the Qlik Sense application directly from the documentation page for further inspection or development.
The generated documentation reflects the application state at the selected commit and serves as a reliable reference for analysis, review, and knowledge sharing.