Overhauling CerberusX Documentation

Phil7

Administrator
CX Code Contributor
3rd Party Tool Dev
Joined
Jun 26, 2017
Messages
549
So I will go with language guide then. Thanks for the feedback.

The sequence that topics are introduced and how they are grouped is even more important

There is a link to the language guide in the first post. The content is mostly the old stuff, but I changed the sequence and the grouping a lot.
Your other comments look a bit vague to me. There are definitely different needs to be met for beginners and experts. For that reason I wrote a quick guide to the language for the experts and I try to write as easy as I can so every beginner should understand the language guide at least if read from start to finish.
 
Last edited:

Jimmy

Active member
3rd Party Module Dev
Tutorial Author
Joined
Jan 2, 2020
Messages
576
if you make the text for beginners in mind, then experts can can use it without any slowdowns as long as there's a basic section and a separate more-detailed section that's easy to skip when you're an expert on the subject.

I would really like a description of the language to read as if I read about Cerberus-X for the first time and that each section starts by covering everything that there's to know using as few words as possible. When you're an expert you could use the same text using visible keywords inside each logically grouped section.

And placing a short example between the beginner and expert-text would always be useful for both, so you don't have to remember any details. That's a key idea I wanted to bring to the table, it's just an idea. Hope this fleshed it out abit better.
 
Last edited:

Phil7

Administrator
CX Code Contributor
3rd Party Tool Dev
Joined
Jun 26, 2017
Messages
549
I had similar ideas when I was starting with this. Did you read into the language guide?
I am still not sure if I understood you correctly. Maybe I need an example ;-)
What do you mean by visible keywords? Highlighted or bold important words that transport the message?

Here are some thoughts that came up when trying my version of beginner and expert paragraphs covering the same topic:
- How to deal with intermediate programmers?
- How to get from beginner to expert by reading the guide?
- What about technical terms? They make experts understand quickly while leaving beginners frustrated.
- What about the stuff that is written in an easy language for beginners? Should I put the same content in a more detailed way into the expert section?
- What is the stuff that a beginner has to know? Where to make the cut?

These thoughts are the reason why I am on a different route now. Maybe I can sketch out my current approach next time ...
 
Top Bottom