Curating knowledge notes

Knowledge notes are how your organization's own know-how reaches every chat. Note admins review what the agent proposes and add their own.

The flow

1. During a chat, the agent learns something worth keeping and proposes a note on a card.
2. The user's yes saves it as proposed. It isn't used yet.
3. A note admin reviews and approves it. From then on it goes with the turns it is relevant to.

A note admin's own yes on the card approves the note at once.

From the terminal

crewdesk notes list [--status proposed|approved]   # this organization's notes
crewdesk notes list --product                      # Crewdesk's own notes about CrewAI and AMP
crewdesk notes show ID
crewdesk notes add --title "…" --text "…" --keyword "…"   # text: 600 characters at most; --keyword repeats
crewdesk notes add … --automation NAME              # a note about one automation
crewdesk notes edit ID --text "…"
crewdesk notes approve ID
crewdesk notes remove ID

Writing a good note

• One fact per note, in plain words: what a status means, which input takes the normalized name, why a known failure happens.
• Keywords the user would actually type.
• No credentials or personal data: notes are scanned for secrets, and they are read by everyone in the organization.
• Use the automation layer for a fact about one automation, so it reaches only the turns about it.