2 ms·
According to the Diataxis model of documentation [0], the linked project is a "reference", not a "guide". It's a reference because it's information-oriented, a
by lioeters 4y ago
According to the Diataxis model of documentation [0], the linked project is a "reference", not a "guide".
It's a reference because it's information-oriented, and serves users who want to look up something based on category or keyword.
A "guide for getting started" would be a tutorial, serving the needs of the user who is at study. It should provide a successful learning experience.
The project would also benefit from how-to guides, to serve the needs of the user who have a certain task in mind that they want to accomplish.
[0] https://diataxis.fr/ https://diataxis.fr/