rebrand Scirium docs (Wall-O -> Scirium) + add v1/v2 documentation package
This commit is contained in:
@@ -0,0 +1,53 @@
|
||||
# Scirium User Guide
|
||||
|
||||
Status: PLANNED
|
||||
Audience: staff (end users)
|
||||
|
||||
## 1. How to Ask
|
||||
|
||||
You can reach an agent two ways:
|
||||
|
||||
| Mode | Use it for | How |
|
||||
|---|---|---|
|
||||
| Channel @mention | Questions the whole team benefits from; answers stay searchable in the room | Type @ followed by the agent name, then your question. |
|
||||
| DM the bot | Private follow-up, clarification, or a 1:1 thread | Open a direct message with the agent bot and type your question. |
|
||||
|
||||
Both paths produce the same cited answer format. Only the destination differs.
|
||||
|
||||
## 2. What a Good Question Looks Like
|
||||
|
||||
Ask a complete question about a specific topic in the channel's domain. For example, in the Billing channel, ask "What is our refund policy on a disputed charge?" rather than "refund?".
|
||||
|
||||
## 3. How Citations Work
|
||||
|
||||
Every answer cites its sources in two places:
|
||||
|
||||
1. Inline markers, such as [1], [2], next to the sentences they support.
|
||||
2. A Sources footer at the end of the answer listing each cited document title and a link.
|
||||
|
||||
Click the source link to open the document and verify the answer yourself. This is the point of the product: you can always check the source.
|
||||
|
||||
## 4. When the Answer Says It Is Not in the Knowledge Base
|
||||
|
||||
If the answer says "I could not find an answer in the knowledge base for this question", it means one of:
|
||||
|
||||
| Reason | What to do |
|
||||
|---|---|
|
||||
| The document is not in this channel's scope | Ask in the right channel, or ask an admin to add the document to the scope. |
|
||||
| The question is outside this channel's domain | Ask the matching channel (for example HR questions go to the Employee Resources channel). |
|
||||
| The answer genuinely is not documented | Ask a human, or ask an admin to add the missing document. |
|
||||
|
||||
Do not rephrase and expect a guess. Scirium is designed to say it does not know rather than invent an answer.
|
||||
|
||||
## 5. What Scirium Cannot Do
|
||||
|
||||
- It cannot answer from documents outside the channel's scope.
|
||||
- It cannot answer questions about patient records or personal health information.
|
||||
- It cannot take actions on your behalf (v1). It answers questions only.
|
||||
- It cannot invent an answer when the source is missing.
|
||||
|
||||
## 6. Tips
|
||||
|
||||
- Keep a question to one topic for the clearest citations.
|
||||
- If the answer is close but not quite right, DM the bot a follow-up with more detail.
|
||||
- If a source link does not open, report it to an admin; the document may have moved or been removed from the scope.
|
||||
Reference in New Issue
Block a user