# HG changeset patch # User matthew@heavyhorse.vm.bytemark.co.uk # Date 1271440304 -3600 # Node ID 35a99353d907fee50034b587616df3f01f4c3fbc # Parent 603d9caeb6d51044180f4ebfe2d53ddcc16b6224 Add documentation to README for assistants diff -r 603d9caeb6d5 -r 35a99353d907 README --- a/README Fri Apr 16 18:46:08 2010 +0100 +++ b/README Fri Apr 16 18:51:44 2010 +0100 @@ -92,6 +92,22 @@ On clicking this link the user would be presented with a form to enter their query. +Assistants +---------- + +To become available to answer user queries, assistants should join the relevant team +MUC room(s). When a user submits a query they will receive a message with the query +and the address of a room to join if they wish to assist the user. + +The first assistant to join the room is automatically marked as the user's primary +assistant, and the user will be notified of their presence. They can simply converse +with the user as normal at this point. + +While in the query room with the user present, 2 commands are available. Anyone may +type the message "!assist" to notify the user that they will be the new primary +assistant. If the assistant wishes to notify the user that they are no longer have an +assistant they may type the message "!stop", or simply leave the room. + License ------- support-chat is licensed under the University of Illinois/NCSA Open Source License,