diff --git a/doc/source/gui/_assets/add_board_owner.png b/doc/source/gui/_assets/add_board_owner.png new file mode 100644 index 00000000..db659c28 Binary files /dev/null and b/doc/source/gui/_assets/add_board_owner.png differ diff --git a/doc/source/gui/_assets/add_board_user.png b/doc/source/gui/_assets/add_board_user.png new file mode 100644 index 00000000..b1c0141c Binary files /dev/null and b/doc/source/gui/_assets/add_board_user.png differ diff --git a/doc/source/gui/_assets/add_board_worklists.png b/doc/source/gui/_assets/add_board_worklists.png new file mode 100644 index 00000000..e6941f86 Binary files /dev/null and b/doc/source/gui/_assets/add_board_worklists.png differ diff --git a/doc/source/gui/_assets/automatic_worklist_criteria.png b/doc/source/gui/_assets/automatic_worklist_criteria.png new file mode 100644 index 00000000..a20eddb1 Binary files /dev/null and b/doc/source/gui/_assets/automatic_worklist_criteria.png differ diff --git a/doc/source/gui/_assets/create_board.png b/doc/source/gui/_assets/create_board.png new file mode 100644 index 00000000..cfaccbcb Binary files /dev/null and b/doc/source/gui/_assets/create_board.png differ diff --git a/doc/source/gui/best_practices.rst b/doc/source/gui/best_practices.rst new file mode 100644 index 00000000..1bb27e80 --- /dev/null +++ b/doc/source/gui/best_practices.rst @@ -0,0 +1,36 @@ +============== +Best Practices +============== + +Organizing a Team +================= + +#. Tags: Teams should decide on a list of tags they will be using and document + them. Examples: nova-m1, bug, driver, low-hanging-fruit. The tags that are + important to your team will depend heavily on how you like to organize work. + If your team targets milestones, you might need tags for the milestones. If + your team has a lot of driver work and you have a tag for each vendor, you + should use those. In the end, the only thing that is important is that they + are clear and well documented. + +#. Boards: Two of the most common ways of organizing works in boards are- + + #. Using a board to organize work in a kanban style- worklists for new, + backlog, in progress, and done. Stories are arranged in the list by + priority- higher priority items closer to the top. + + #. A board per release with each worklist being a separate milestone. + Stories that are in the worklist are organized by priority. + +#. Worklists: Worklists can exist in a board or on their own. Most often, they + are used in the context of boards. + + +Organizing Your Work +==================== + +Its possible, even likely, that your personal priorities differ from +that of the project(s) you are working on. You might have to balance +and organize work you are involved in between several projects and +SIGs. This is why StoryBoard supports the creation of worklists and +boards by anyone. diff --git a/doc/source/gui/boards.rst b/doc/source/gui/boards.rst new file mode 100644 index 00000000..1949c414 --- /dev/null +++ b/doc/source/gui/boards.rst @@ -0,0 +1,28 @@ +============= + Using Boards +============= + +Basic Workflow +============== + +Here's an example board for a project team: + +#. Make a board: + + .. image:: _assets/create_board.png + :width: 95% + +#. Add Worklists(lanes). + + .. image:: _assets/add_board_worklists.png + :width: 95% + +#. Add other owners to the board: + + .. image:: _assets/add_board_owner.png + :width: 95% + +#. Add users to the board: + + .. image:: _assets/add_board_user.png + :width: 95% diff --git a/doc/source/gui/theory.rst b/doc/source/gui/theory.rst index 603f1839..8a76918f 100644 --- a/doc/source/gui/theory.rst +++ b/doc/source/gui/theory.rst @@ -85,6 +85,9 @@ criterai for an automatic worklist: .. image:: _assets/example-automatic-worklist-filters.png +For more information about how to create and edit worklists, see +:ref: 'this documentation '. + We also have boards, which are akin to collections of worklists. Here's an example: @@ -110,6 +113,9 @@ owners. Users can move and delete cards, but only owners can delete lanes or change the metadata of the board itself (eg: its title or description). +For documentation on how to create boards, add users/owners, etc +:ref: 'that can be located here '. + Complex Priority ================ diff --git a/doc/source/gui/worklists.rst b/doc/source/gui/worklists.rst index 6d3006b9..2a6e9df2 100644 --- a/doc/source/gui/worklists.rst +++ b/doc/source/gui/worklists.rst @@ -94,6 +94,21 @@ 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! +Automatic Worklists +=================== + +You can make standalone automatic worklists or automatic worklists that +exist in a board. You set up criteria when you create the worklist to +funnel the relevant stories in the worklist. Criteria can be set up to +filter tasks or stories into an automatic worklist. + +.. image:: _assets/automatic_worklist_criteria.png + +If you have a board of automatic worklists, you can't manually move +the stories around from list to list, the criteria that makes it +appear in a certain worklist has to change for it to move. + + Worklist Notifications ====================== diff --git a/doc/source/index.rst b/doc/source/index.rst index 063c2b24..803b7505 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -37,8 +37,10 @@ Using StoryBoard :maxdepth: 1 How it Works - Tasks, Stories, & Tags + Boards Worklists + Tasks, Stories, & Tags + Organizing Your Work: Best Practices Installation guides -------------------