storyboard/doc/source/gui/best_practices.rst
Kendall Nelson 234ac1b68b Add to & Reorganize StoryBoard GUI Docs
This patch does a little reorganization of the gui docs.
It adds a section solely focused on the creation and
functions of boards. It also adds a section on best
practices as we get a lot of questions about how things
should be done.

Change-Id: Id208d2edb754030a75ba2c1884fd8ef0b620a6af
2018-06-25 14:38:30 -07:00

37 lines
1.4 KiB
ReStructuredText

==============
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.