MootBot
|
Size: 2865
Comment: Change sections on demos and added launchpad link
|
Size: 5055
Comment: Revised documentation for MootBot
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 4: | Line 4: |
| MootBot is a bot that has been designed to make the process of summarizing meetings easier. It is a modified eggdrop bot, running a custom script written in TCL. It picks up on specific text in the meeting, and outputs only the relevant pieces of text, producing an easy to read summary of the meeting. | MootBot is a bot that has been designed to make the process of summarizing meetings easier. It is a modified [http://www.eggheads.org/ eggdrop bot], running a custom script written in TCL. == Who Would Use It? == MootBot was designed for Chairperson of a meeting to use. A chairperson can flag parts of the meeting for specific topics, actions, and agreed resolutions, which will be outputted into a HTML document to enable easier browsing of the IRC chat logs. == How do I request the bot? == The bot will always be available in the #ubuntu-meeting channel, If you are running a meeting in a different channel then contact someone in the [irc://irc.freenode.net/#ubuntu-scribes #ubuntu-scribes] IRC channel. In the future we will have an automated system to request the bot at specific times. |
| Line 7: | Line 13: |
| Line 19: | Line 24: |
| This meeting structure is a modified version of a scheme created by NikButler | |
| Line 21: | Line 25: |
| To begin the meeting, the chairperson issues the "#startmeeting" command. This tells the bot to start logging. Next, the chairperson sends a message starting with [TOPIC], followed by the first topic to be discussed. For example: | === Starting a Meeting === To begin the meeting, the chairperson issues the "#startmeeting" command. This tells the bot to start logging. |
| Line 24: | Line 29: |
| <Seeker`>[Topic] Agenda item 1 | <AndrewWilliams> #startmeeting <MootBot> Meeting started at 23:00 |
| Line 27: | Line 33: |
| This will cause the bot to log the first topic as "Agenda item 1". When a topic has been fully discussed, the chairperson should issue another [TOPIC] command with the new topic. | After issuing the #startmeeting command, the rest of the commands will be enabled. |
| Line 29: | Line 35: |
| As the meeting progresses, any people with suggestions should mark them with an [IDEA] tag. This will cause the bot to log the idea under the current topic. This tag can be used by anyone. | === Changing the Topic === As you progress through the meeting the current discussion point should be noted to enable easier reading of the IRC logs. You can change the current topic of discussion by issuing a [TOPIC] command: |
| Line 31: | Line 38: |
| If a vote is needed, the chairperson should issue a message starting with the [VOTE] command. | {{{ <AndrewWilliams> [TOPIC] Changing the Topic <MootBot> Current Topic: Changing the Topic }}} |
| Line 33: | Line 43: |
| Need to finish this. | === Ideas, Actions and Agreed Actions === The [IDEA] command are supplied so attendees can provide and log ideas regarding the current topic of discussion, this is useful in brainstorming sessions where all input should be registered for future examination. {{{ <AndrewWilliams> [IDEA] Provide full details of the commands on the Wiki <MootBot> New Idea Received: Provide full details of the commands on the Wiki }}} Similar to this is the [ACTION] and [AGREED] commands, but these can only be used by the Chairperson. This will add an entry into the log denoting a action to be took, or a agreement on the current topic. {{{ <AndrewWilliams> [ACTION] Manual to be produced by AndrewWilliams <MootBot> New Action Received: Manual to be produced by AndrewWilliams <AndrewWilliams> [AGREED] Work on documentation will commence as soon as possible <MootBot> Agreed: Work on documentation will commence as soon as possible }}} === Voting === The bot offers a voting mechinism to enable the chairperson to hold a public vote regarding a particular topic. A vote is started via the [VOTE] command. {{{ <AndrewWilliams> [VOTE] Do we implement channel managment? <MootBot> New Vote: Do we implement channel managment? }}} Atendees can vote by using the +1/-1 commands: {{{ <AndrewWilliams> +1 <AndrewWilliams> -1 }}} After a time the chairperson can close the vote (using the #endvote command) and receive the results: {{{ <AndrewWilliams> #endvote <MootBot> Vote on "Do we implement channel managment?", 1 For, 1 Against }}} === Ending the Meeting === After all topics are discussed, the chairperson can then call a close to the meeting using the #endmeeting command {{{ <AndrewWilliams> #endmeeting <MootBot> Meeting Ended: 23:10 <MootBot> Summary available at: http://rimmer.incognitus.net/~mootbot/test-20070221.html }}} |
| Line 36: | Line 95: |
Some sample output can be found [http://cjo20.net/bot here] |
Some recent output can be found [http://rimmer.incognitus.net/~mootbot/ here] |
| Line 40: | Line 98: |
| The (non-exhaustive) planned feature list is: * Add option to limit voting to specific people * Use <div>'s in output instead of a table * Add timestamps to the output (Done) * Link summary points to actual text in the log (Done) * Add a list of people who said something during the meeting * Allow the bot echo to be turned off More information on current planned features are available on the [http://www.launchpad.net/mootbot Launchpad entry] |
More information on current planned features are available on the [http://www.launchpad.net/mootbot Launchpad entry], Suggestions are welcome. |
| Line 52: | Line 101: |
| You can try the bot out in the #mootbot-test channel on irc.freenode.net. If you have any further questions just ask someone in the #ubuntu-scribes channel. Please feel free to try out starting meetings and various other commands, but we ask if someone else is testing the bot that you wait until they've finished. | |
| Line 53: | Line 103: |
| You can try the bot out in the #MootBot-Test channel on irc.freenode.net. If you have any further questions just ask someone in the #ubuntu-scribes channel. | == I have another question... == Please read the MootBot FAQ to see if your question is covered, If not then just drop into the #ubuntu-scribes channel and ask. |
Moot Bot
What is it?
MootBot is a bot that has been designed to make the process of summarizing meetings easier. It is a modified [http://www.eggheads.org/ eggdrop bot], running a custom script written in TCL.
Who Would Use It?
MootBot was designed for Chairperson of a meeting to use. A chairperson can flag parts of the meeting for specific topics, actions, and agreed resolutions, which will be outputted into a HTML document to enable easier browsing of the IRC chat logs.
How do I request the bot?
The bot will always be available in the #ubuntu-meeting channel, If you are running a meeting in a different channel then contact someone in the [irc://irc.freenode.net/#ubuntu-scribes #ubuntu-scribes] IRC channel. In the future we will have an automated system to request the bot at specific times.
How do I use it?
The commands for the bot are shown below:
#startmeeting |
Tells the bot to start listening. Sets the meeting chair to whoever issues this command |
[TOPIC] |
Records a topic of discussion (Can only be issued by the meeting chair) |
[IDEA] |
Records an idea releated to the current topic of discussion (Can be used by everyone) |
[VOTE] |
Starts a vote. (Can only be issued by the meeting chair) |
+1 / -1 |
Records a vote for the current [VOTE]. (Can be used by everyone) |
#endvote |
Finishes the current [VOTE] (Can only be issued by the meeting chair) |
[ACTION] |
Records an action that is decided on (Can only be issued by the meeting chair) |
[AGREED] |
Records and agreement on a idea (Can only be issued by the meeting chair) |
#endmeeting |
Ends the meeting (Can only be issued by the meeting chair) |
Starting a Meeting
To begin the meeting, the chairperson issues the "#startmeeting" command. This tells the bot to start logging.
<AndrewWilliams> #startmeeting <MootBot> Meeting started at 23:00
After issuing the #startmeeting command, the rest of the commands will be enabled.
Changing the Topic
As you progress through the meeting the current discussion point should be noted to enable easier reading of the IRC logs. You can change the current topic of discussion by issuing a [TOPIC] command:
<AndrewWilliams> [TOPIC] Changing the Topic <MootBot> Current Topic: Changing the Topic
Ideas, Actions and Agreed Actions
The [IDEA] command are supplied so attendees can provide and log ideas regarding the current topic of discussion, this is useful in brainstorming sessions where all input should be registered for future examination.
<AndrewWilliams> [IDEA] Provide full details of the commands on the Wiki <MootBot> New Idea Received: Provide full details of the commands on the Wiki
Similar to this is the [ACTION] and [AGREED] commands, but these can only be used by the Chairperson. This will add an entry into the log denoting a action to be took, or a agreement on the current topic.
<AndrewWilliams> [ACTION] Manual to be produced by AndrewWilliams <MootBot> New Action Received: Manual to be produced by AndrewWilliams <AndrewWilliams> [AGREED] Work on documentation will commence as soon as possible <MootBot> Agreed: Work on documentation will commence as soon as possible
Voting
The bot offers a voting mechinism to enable the chairperson to hold a public vote regarding a particular topic. A vote is started via the [VOTE] command.
<AndrewWilliams> [VOTE] Do we implement channel managment? <MootBot> New Vote: Do we implement channel managment?
Atendees can vote by using the +1/-1 commands:
<AndrewWilliams> +1 <AndrewWilliams> -1
After a time the chairperson can close the vote (using the #endvote command) and receive the results:
<AndrewWilliams> #endvote <MootBot> Vote on "Do we implement channel managment?", 1 For, 1 Against
Ending the Meeting
After all topics are discussed, the chairperson can then call a close to the meeting using the #endmeeting command
<AndrewWilliams> #endmeeting <MootBot> Meeting Ended: 23:10 <MootBot> Summary available at: http://rimmer.incognitus.net/~mootbot/test-20070221.html
What output does the bot produce?
Some recent output can be found [http://rimmer.incognitus.net/~mootbot/ here]
What features are plannned?
More information on current planned features are available on the [http://www.launchpad.net/mootbot Launchpad entry], Suggestions are welcome.
Can I see the bot in action?
You can try the bot out in the #mootbot-test channel on irc.freenode.net. If you have any further questions just ask someone in the #ubuntu-scribes channel. Please feel free to try out starting meetings and various other commands, but we ask if someone else is testing the bot that you wait until they've finished.
I have another question...
Please read the MootBot FAQ to see if your question is covered, If not then just drop into the #ubuntu-scribes channel and ask.
ScribesTeam/MootBot (last edited 2010-03-12 11:40:55 by multi)