refocusing the documentation on users #5
alexschroeter
started this conversation in
General
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
I was going through the documentation again and I am wondering if the initial focus should be users (not administrators / developers). Right now, the documentation starts with how it works and why this is good. Although I believe these points are relevant for more advanced users, I believe the documentation should work as the most basic introduction for the biggest group of people. Therefore, I would propose to reorganize the documentation and focus on the things that get people started. If they are interested in learning more they can read the rest.
Without having reread the whole Documentation, I believe these are the major points I would tackle:
I think this is a bit more in line with our audience and will help get people to use Arkitekt.
One negative aspect of this structure is that it might discourage people from setting up their server (because they are not administrators). I think this could already be helped by not naming it after the group but the functionality (Users -> Client, Administrator -> Server, Developers -> Apps).
Let me know what you think.
Beta Was this translation helpful? Give feedback.
All reactions