Background
As per discussion, dimagi/open-chat-studio#3010, this Guides content will be grouped under the following menus based on the content.
Task
- Identify and move pages to Tech-Hub if they are obviously for users who are technical or written for Admin users of OCS. For example the "OAuth2" page and the "Python Node" tech details
- If a page has content that is not clearly for the Tech-Hub menu, then create a new issue if the page needs to be split up or rewritten so that content for the Tech-Hub is in a separate page
Menus and what Content should be included
-
Tutorials (Learning-oriented)
The User’s Goal: "I want to learn how to use this."
The Content: A lesson that leads a beginner from zero to a small, successful outcome.
The Rule: Do not explain why something works here; just show them how to do it.
-
How-To Guides (Problem-oriented)
The User’s Goal: "I have a specific task to finish."
The Content: A recipe. A series of steps to achieve a real-world goal
The Rule: Assume the user already knows the basic terminology. Don't teach; just solve.
-
Tech-Hub (Reference Information-oriented)
The User’s Goal: "I need the technical facts."
The Content: Dry, encyclopedia-style descriptions. API endpoints, etc.
The Rule: Be brief, accurate, and structured (tables are your friend here).
-
Concepts (Explanation and Understanding-oriented)
The User’s Goal: "I want to understand the concepts."
The Content: Background, design philosophy, and "the big picture."
The Rule: This is the only place where you are allowed to be "chatty." Use diagrams and talk about the "Why."
Background
As per discussion, dimagi/open-chat-studio#3010, this Guides content will be grouped under the following menus based on the content.
Task
Menus and what Content should be included
Tutorials (Learning-oriented)
The User’s Goal: "I want to learn how to use this."
The Content: A lesson that leads a beginner from zero to a small, successful outcome.
The Rule: Do not explain why something works here; just show them how to do it.
How-To Guides (Problem-oriented)
The User’s Goal: "I have a specific task to finish."
The Content: A recipe. A series of steps to achieve a real-world goal
The Rule: Assume the user already knows the basic terminology. Don't teach; just solve.
Tech-Hub (Reference Information-oriented)
The User’s Goal: "I need the technical facts."
The Content: Dry, encyclopedia-style descriptions. API endpoints, etc.
The Rule: Be brief, accurate, and structured (tables are your friend here).
Concepts (Explanation and Understanding-oriented)
The User’s Goal: "I want to understand the concepts."
The Content: Background, design philosophy, and "the big picture."
The Rule: This is the only place where you are allowed to be "chatty." Use diagrams and talk about the "Why."