Hi @Wizards
This question had been asked several times in the past and there are several topics in the Qlik Community with attachments, some of them with nice ideas, basically, most of these documents focus on documenting individual QVF (or QVW) applications files, with different levels of granularity, I did not see any topic talking about the TOP Level design of the solution, with its components and source databases; I will split project documentation in two areas:
- Project's Spec document, a top level document describing all the objects required to produce the QlikSense applications; this document does not focus on each individual QlikSense object.
- Qlik Application - QVF documentation:
I found these topics, with interesting attachments:
- Design Document Template for Qlikview ; I like the Governance Material attachment, specially and Excel file, although I will rather prefer to collect that information in a DB table with a nice UI to collect these fields per application. Its accepted solution point to these two topics:
I still like the Governance Material attachment!
My preferences:
It is nice to have a Project's Spec Document, explaining the scope of the solution, this document does deal at a higher level of Qlik's objects, let's say, it is good to deploy any solution with any BI tool in the market.
Developers do not like extra work by filling forms tracking applications properties (like the Excel file in the Governance Material above), a document that add complication to their work-flow because they represent extra documenting steps manually maintained; I prefer to embed it into the application itself, within the script file.
I particularly like the way Qlik Document some of their applications, with an About sheet, or About information per sheet, or the Application Description field; like the ones below:
If possible implement some repository software, like GitHub, it will be benefitial in the long run.
I particularly implement a Change Log sheet as the last sheet on each the application, tracking any change done to the individual application, e.g. QVF. I found it easier to maintain by developers and end-users.
You also have Qlik's own metadata always present in their QVDs, you can generate real-time documentation of any application, as long as you implement a QVDs metadata extractor.
Hope this helps,
