Anonymitaet commented on issue #19912:
URL: https://github.com/apache/pulsar/issues/19912#issuecomment-1491260868

   Hi @asafm 
   
   Thanks for your detailed explanations! 
   
   I understand your points, and I'm trying to make the learning path more 
**clear, simple, and direct** for each role.
   
   ### Reasons for designing 3 guides
   
   #### 1. Give prominent directions for users 
   
   Suppose that you're at a fork in the road, it's most **clear** for you to 
choose one way if the **sign** indicates the direction. 
   
   <img width="524" alt="image" 
src="https://user-images.githubusercontent.com/50226895/229011919-e972cb52-4375-4f83-88a2-d296c2512b02.png";>
   
   This is the same for doc users. Whatever the user **archetypes** ("doing" or 
"learning") are, the most important thing is they're seeking solutions to 
resolve issues based on their **roles**. **The roles are signs**.
   
   So if we design the doc IA as below, users just need to choose one way based 
on their roles and finish the left journey. No other stuffs they need to take 
into consideration. It's **simple, clear, and direct**. 
   
   <img width="1057" alt="image" 
src="https://user-images.githubusercontent.com/50226895/229016765-9fe4111a-7fba-4ece-8943-186e2bba2f00.png";>
   
   #### 2. Provide required minimal info for users
   
   > If we put all the topics (as below) into a single [Get 
started](https://pulsar.apache.org/docs/next/getting-started-home/), all roles 
will read them all by sequence, which means a clear learning path is not 
designed in real.
   
   Clarification: "read them all by sequence" means " all roles need to glance 
over all 3 headings (even though they are just interested in and click one 
later)" rather than "read them (docs) one after another".
   
   But if we design 3 guides respectively:
   - Beginners just need to read their Get Started (CLI)
   - Developers just need to read their Get Started (Job queue + Event sourcing)
   - Operators just need to read their Get Started (K8S)
   
   In this way, we provide the required info for each role at a minimal amount. 
Users will like it because it:
   - Saves some effort and time in reading unneeded info
   - Improves the efficiency of finding and using the info 
   - Makes users more confident in what they should and need to do
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to