diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst index 7437b46d..ee4d1f47 100644 --- a/doc/source/user/index.rst +++ b/doc/source/user/index.rst @@ -5,3 +5,4 @@ .. toctree:: theory + worklists diff --git a/doc/source/user/theory.rst b/doc/source/user/theory.rst index a10783b0..93a7e644 100644 --- a/doc/source/user/theory.rst +++ b/doc/source/user/theory.rst @@ -156,93 +156,3 @@ different people's priorities, it just didn't offer any way of tracking whose priorities were whose. So this makes things more open and explicit. We hope to tailor the implementation based on user feedback, and these are the first steps! :) - -Here's an example workflow for a project team: - -#. Make a worklist: - - .. image:: create-worklist.png - -#. Subscribe to it: - - .. image:: subscribe-worklist.png - -#. Next, make a list of tasks you care about from existing stories, by - adding cards to the worklist: - - .. image:: add-card-to-worklist.png - - .. image:: add-task-to-worklist.png - -#. and save it: - - .. image:: save-worklist.png - -It will look something like this: - -.. image:: worklist-after-adding-tasks.png - -You can select users who are allowed to move things on the -worklist. To do so, edit the worklist: - -.. image:: edit-worklist-perms-1.png - -and add people whom you want to be able to interact with the worklist, -eg: to add users: - -.. image:: edit-worklist-perms-2.png - -You can drag and drop tasks in order of priority - -.. image:: drag-n-drop-on-worklist.png - -This lets anyone who views your worklist see the priority of your -tasks, and anyone who subscribes to it see the priority of those tasks -when viewing affected stories. - -You can also do it the other way round, adding existing stories to a -worklist you care about as you see them: - -Browse to a story with a task you care about, and click the arrow next -to that task to expand detailed information and options for it: - -.. image:: add-task-to-worklist-1.png - -Then the 'add to worklist' button: - -.. image:: add-task-to-worklist-2.png - -And add the task to your chosen worklist for team priorities: - -.. image:: add-task-to-worklist-3.png - -.. image:: add-task-to-worklist-4.png - -If you go back to your worklist, that task will now be there! - -.. image:: add-task-to-worklist-5.png - -On a story, tasks that feature in subscribed worklists will appear on -the top-right, along with their position in the worklist: - -.. image:: worklist-subs-on-story.png - -If you are not subscribed to any worklists containing tasks from the -story (or the story itself), that space will be empty, since we only -display this information to people who want it: - -.. image:: story-with-no-worklist-subs.png - -Once you have a team worklist, you can link the worklist on irc or on -the mailing list, etc, wherever it's most visible, and invite people -to subscribe! - -It is possible to subscribe to email notifications for worklists, so -that you can be kept up to date on changes in priority. These -notifications can be toggled in the profile preferences (person icon -on navbar, near the bottom) and are separate from the main email -notifications, to avoid things getting spammy. :) - -Thanks for reading, and we hope this has been useful. - -Have fun, and happy task-tracking! diff --git a/doc/source/user/worklists.rst b/doc/source/user/worklists.rst new file mode 100644 index 00000000..c877f525 --- /dev/null +++ b/doc/source/user/worklists.rst @@ -0,0 +1,104 @@ +================= + Using Worklists +================= + +Basic Workflow +============== + +Here's an example workflow for a project team: + +#. Make a worklist: + + .. image:: create-worklist.png + +#. Subscribe to it: + + .. image:: subscribe-worklist.png + +#. Next, make a list of tasks you care about from existing stories, by + adding cards to the worklist: + + .. image:: add-card-to-worklist.png + + .. image:: add-task-to-worklist.png + +#. and save it: + + .. image:: save-worklist.png + +It will look something like this: + +.. image:: worklist-after-adding-tasks.png + +Setting Permissions +=================== + +You can select users who are allowed to move things on the +worklist. To do so, edit the worklist: + +.. image:: edit-worklist-perms-1.png + +and add people whom you want to be able to interact with the worklist, +eg: to add users: + +.. image:: edit-worklist-perms-2.png + +Setting Priorities +================== + +You can drag and drop tasks in order of priority + +.. image:: drag-n-drop-on-worklist.png + +This lets anyone who views your worklist see the priority of your +tasks, and anyone who subscribes to it see the priority of those tasks +when viewing affected stories. + +Populating a Worklist Manually +============================== + +You can also do it the other way round, adding existing stories to a +worklist you care about as you see them: + +Browse to a story with a task you care about, and click the arrow next +to that task to expand detailed information and options for it: + +.. image:: add-task-to-worklist-1.png + +Then the 'add to worklist' button: + +.. image:: add-task-to-worklist-2.png + +And add the task to your chosen worklist for team priorities: + +.. image:: add-task-to-worklist-3.png + +.. image:: add-task-to-worklist-4.png + +If you go back to your worklist, that task will now be there! + +.. image:: add-task-to-worklist-5.png + +On a story, tasks that feature in subscribed worklists will appear on +the top-right, along with their position in the worklist: + +.. image:: worklist-subs-on-story.png + +If you are not subscribed to any worklists containing tasks from the +story (or the story itself), that space will be empty, since we only +display this information to people who want it: + +.. image:: story-with-no-worklist-subs.png + +Once you have a team worklist, you can link the worklist on irc or on +the mailing list, etc, wherever it's most visible, and invite people +to subscribe! + +Worklist Notifications +====================== + +It is possible to subscribe to email notifications for worklists, so +that you can be kept up to date on changes in priority. These +notifications can be toggled in the profile preferences (person icon +on navbar, near the bottom) and are separate from the main email +notifications, to avoid things getting spammy. :)